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.104 by root, Wed Jan 25 13:24:45 2006 UTC vs.
Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 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
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 (B<-d> still
95respected). In the absence of this option, the display specified by the 98respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 99B<DISPLAY> environment variable is used.
97 100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
98=item B<-geometry> I<geom> 106=item B<-geometry> I<geom>
99 107
100Window geometry (B<-g> still respected); resource B<geometry>. 108Window geometry (B<-g> still respected); resource B<geometry>.
101 109
102=item B<-rv>|B<+rv> 110=item B<-rv>|B<+rv>
103 111
104Turn on/off simulated reverse video; resource B<reverseVideo>. 112Turn on/off simulated reverse video; resource B<reverseVideo>.
105 113
106=item B<-j>|B<+j> 114=item B<-j>|B<+j>
107 115
108Turn on/off jump scrolling; resource B<jumpScroll>. 116Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 117
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 118=item B<-ss>|B<+ss>
111 119
112Turn on/off inheriting parent window's pixmap. Alternative form is 120Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 121
122=item B<-tr>|B<+tr>
123
124Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126B<-ip> is still accepted as an obsolete alias but will be removed in
127future versions.
128
129I<Please address all transparency related issues to Sasha Vasko at
130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 131
115=item B<-fade> I<number> 132=item B<-fade> I<number>
116 133
117Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 136colour; resource B<fading>.
120 137
121=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
122 139
123Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
125 142
126=item B<-tint> I<colour> 143=item B<-tint> I<colour>
127 144
128Tint the transparent background pixmap with the given colour when 145Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 146transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 147non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 148used to brighten or darken the image in addition to tinting it.
149Please note that certain tint colours can be applied on the server-side,
150thus yielding performance gain of two orders of magnitude. These colours are:
151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 153I<tintColor>. Example:
133 154
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 155 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 156
136=item B<-sh> 157=item B<-sh> I<number>
137 158
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 159Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 160background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 161resource I<shading>.
162
163=item B<-blt> I<string>
164
165Specify background blending type. If background pixmap is specified
166at the same time as transparency - such pixmap will be blended over
167transparency image, using method specified. Supported values are :
168B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171alpha-blending. Compile I<afterimage>; resource I<blendType>.
172
173=item B<-blr> I<HxV>
174
175Apply Gaussian Blur with the specified radii to the transparent
176background image. If single number is specified - both vertical and
177horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180resource I<blurRadius>.
141 181
142=item B<-bg> I<colour> 182=item B<-bg> I<colour>
143 183
144Window background colour; resource B<background>. 184Window background colour; resource B<background>.
145 185
146=item B<-fg> I<colour> 186=item B<-fg> I<colour>
147 187
148Window foreground colour; resource B<foreground>. 188Window foreground colour; resource B<foreground>.
149 189
150=item B<-pixmap> I<file[;geom]> 190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 191
152Compile I<XPM>: Specify XPM file for the background and also optionally 192Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 193optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 194add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 195command-line; for more details see resource B<backgroundPixmap>.
156 196
157=item B<-cr> I<colour> 197=item B<-cr> I<colour>
158 198
159The cursor colour; resource B<cursorColor>. 199The cursor colour; resource B<cursorColor>.
160 200
177that are checked in order when trying to find glyphs for characters. The 217that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 218first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 219smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 220font list is always appended to it. See resource B<font> for more details.
181 221
182In short, to specify an X11 core font, just specify it's name or prefix it 222In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 223with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 224e.g.:
185 225
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 226 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 227 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 245italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 246for details.
207 247
208=item B<-is>|B<+is> 248=item B<-is>|B<+is>
209 249
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 250Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 251foreground/background (default). See resource B<intensityStyles> for
212details. 252details.
213 253
214=item B<-name> I<name> 254=item B<-name> I<name>
215 255
313 353
314=item B<-lsp> I<number> 354=item B<-lsp> I<number>
315 355
316Compile I<frills>: Lines (pixel height) to insert between each row of 356Compile I<frills>: Lines (pixel height) to insert between each row of
317the display. Useful to work around font rendering problems; resource 357the display. Useful to work around font rendering problems; resource
318B<linespace>. 358B<lineSpace>.
319 359
320=item B<-tn> I<termname> 360=item B<-tn> I<termname>
321 361
322This option specifies the name of the terminal type to be set in the 362This option specifies the name of the terminal type to be set in the
323B<TERM> environment variable. This terminal type must exist in the 363B<TERM> environment variable. This terminal type must exist in the
377for more info. 417for more info.
378 418
379=item B<-tcw> 419=item B<-tcw>
380 420
381Change the meaning of triple-click selection with the left mouse 421Change the meaning of triple-click selection with the left mouse
422button. Only effective when the original (non-perl) selection code is
382button. Instead of selecting a full line it will extend the selection the 423in-use. Instead of selecting a full line it will extend the selection to
383end of the logical line only. resource B<tripleclickwords>. 424the end of the logical line only. resource B<tripleclickwords>.
384 425
385=item B<-insecure> 426=item B<-insecure>
386 427
387Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
388sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
409Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
410will not immediately destroy its window when the program executed within 451will not immediately destroy its window when the program executed within
411it exits. Instead, it will wait till it is being killed or closed by the 452it exits. Instead, it will wait till it is being killed or closed by the
412user; resource B<hold>. 453user; resource B<hold>.
413 454
455=item B<-xrm> I<string>
456
457Works like the X Toolkit option of the same name, by adding the I<string>
458as if it were specified in a resource file. Resource values specified this
459way take precedence over all other resource specifications.
460
461Note that you need to use the I<same> syntax as in the .Xdefaults file,
462e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
463options can be specified as long-options on the commandline, so use
464of B<-xrm> is mostly limited to cases where you want to specify other
465resources (e.g. for input methods) or for compatibility with other
466programs.
467
414=item B<-keysym.>I<sym> I<string> 468=item B<-keysym.>I<sym> I<string>
415 469
416Remap a key symbol. See resource B<keysym>. 470Remap a key symbol. See resource B<keysym>.
417 471
418=item B<-embed> I<windowid> 472=item B<-embed> I<windowid>
419 473
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 474Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 475which enables applications to easily embed a terminal.
422 476
423Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 477Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
424shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 478shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
425quite a bit, so don't expect it to keep some specific state. It's best to 479quite a bit, so don't expect it to keep some specific state. It's best to
428The window will not be destroyed when @@RXVT_NAME@@ exits. 482The window will not be destroyed when @@RXVT_NAME@@ exits.
429 483
430It might be useful to know that @@RXVT_NAME@@ will not close file 484It might be useful to know that @@RXVT_NAME@@ will not close file
431descriptors passed to it (except for stdin/out/err, of course), so you 485descriptors passed to it (except for stdin/out/err, of course), so you
432can use file descriptors to communicate with the programs within the 486can use file descriptors to communicate with the programs within the
433terminal. This works regardless of wether the C<-embed> option was used or 487terminal. This works regardless of whether the C<-embed> option was used or
434not. 488not.
435 489
436Here is a short Gtk2-perl snippet that illustrates how this option can be 490Here is a short Gtk2-perl snippet that illustrates how this option can be
437used (a longer example is in F<doc/embed>): 491used (a longer example is in F<doc/embed>):
438 492
443 }); 497 });
444 498
445=item B<-pty-fd> I<file descriptor> 499=item B<-pty-fd> I<file descriptor>
446 500
447Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 501Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
448pair but instead use the given filehandle as the tty master. This is 502pair but instead use the given file descriptor as the tty master. This is
449useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 503useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450without having to run a program within it. 504without having to run a program within it.
451 505
452If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 506If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
453entries and will not tinker with pty/tty permissions - you have to do that 507entries and will not tinker with pty/tty permissions - you have to do that
454yourself if you want that. 508yourself if you want that.
455 509
456As an extremely special case, specifying C<-1> will completely suppress 510As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations. 511pty/tty operations, which is probably only useful in conjunction with some
512perl extension that manages the terminal.
458 513
459Here is a example in perl that illustrates how this option can be used (a 514Here is a example in perl that illustrates how this option can be used (a
460longer example is in F<doc/pty-fd>): 515longer example is in F<doc/pty-fd>):
461 516
462 use IO::Pty; 517 use IO::Pty;
476Comma-separated list of perl extension scripts to use (or not to use) in 531Comma-separated list of perl extension scripts to use (or not to use) in
477this terminal instance. See resource B<perl-ext> for details. 532this terminal instance. See resource B<perl-ext> for details.
478 533
479=back 534=back
480 535
481=head1 RESOURCES (available also as long-options) 536=head1 RESOURCES
482 537
483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 538Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
484options) compiled into your version. 539options) compiled into your version. All resources are also available as
540long-options.
485 541
486You can set and change the resources using X11 tools like B<xrdb>. Many 542You can set and change the resources using X11 tools like B<xrdb>. Many
487distribution do also load settings from the B<~/.Xresources> file when X 543distribution do also load settings from the B<~/.Xresources> file when X
488starts. @@RXVT_NAME@@ will consult the following files/resources in order, 544starts. @@RXVT_NAME@@ will consult the following files/resources in order,
489with later settings overwriting earlier ones: 545with later settings overwriting earlier ones:
491 1. system-wide app-defaults file, either locale-dependent OR global 547 1. system-wide app-defaults file, either locale-dependent OR global
492 2. app-defaults file in $XAPPLRESDIR 548 2. app-defaults file in $XAPPLRESDIR
493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
494 4. SCREEN_RESOURCES for the current screen 550 4. SCREEN_RESOURCES for the current screen
495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline
496 553
497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
498names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 555names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
499common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 556common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
500configured, while the class name B<URxvt> allows resources unique to 557configured, while the class name B<URxvt> allows resources unique to
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 562check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 563extensions not documented here):
507 564
508=over 4 565=over 4
509 566
567=item B<depth:> I<bitdepth>
568
569Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>.
571
510=item B<geometry:> I<geom> 572=item B<geometry:> I<geom>
511 573
512Create the window with the specified X window geometry [default 80x24]; 574Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 575option B<-geometry>.
514 576
550Use the specified colour to display underlined characters when the 612Use the specified colour to display underlined characters when the
551foreground colour is the default. 613foreground colour is the default.
552 614
553=item B<colorRV:> I<colour> 615=item B<colorRV:> I<colour>
554 616
555Use the specified colour as the background for reverse video 617Use the specified colour as the background for reverse video characters
556characters. 618when OPTION_HC is disabled (--disable-frills).
557 619
558=item B<underlineColor:> I<colour> 620=item B<underlineColor:> I<colour>
559 621
560If set, use the specified colour as the colour for the underline 622If set, use the specified colour as the colour for the underline
561itself. If unset, use the foreground colour. 623itself. If unset, use the foreground colour.
577option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLORS AND GRAPHICS> section.
579 641
580=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
581 643
582B<True>: specify that jump scrolling should be used. When scrolling 644B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
646has been read, resulting in fewer updates while still displaying every
647received line; option B<-j>.
648
584B<False>: specify that smooth scrolling should be used; option B<+j>. 649B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
650force a screen refresh on each new line it received; option B<+j>.
585 651
586=item B<inheritPixmap:> I<boolean> 652=item B<skipScroll:> I<boolean>
587 653
588B<True>: make the background inherit the parent windows' pixmap, giving 654B<True>: (the default) specify that skip scrolling should be used. When
589artificial transparency. B<False>: do not inherit the parent windows' 655receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590pixmap. 656(around 60 times per second), resulting in far fewer updates. This can
657result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
658option B<-ss>.
659
660B<False>: specify that everything is to be displayed, even
661if the refresh is too fast for the human eye to read anything (or the
662monitor to display anything); option B<+ss>.
663
664=item B<transparent:> I<boolean>
665
666Turn on/off illusion of a transparent window background.
667
668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669future versions.
670
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
591 673
592=item B<fading:> I<number> 674=item B<fading:> I<number>
593 675
594Fade the text by the given percentage when focus is lost; option B<-fade>. 676Fade the text by the given percentage when focus is lost; option B<-fade>.
595 677
603Tint the transparent background pixmap with the given colour; option 685Tint the transparent background pixmap with the given colour; option
604B<-tint>. 686B<-tint>.
605 687
606=item B<shading:> I<number> 688=item B<shading:> I<number>
607 689
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 690Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609image in addition to tinting it. 691in addition to tinting it; option B<-sh>.
692
693=item B<blendType:> I<string>
694
695Specify background blending type; option B<-blt>.
696
697=item B<blurRadius:> I<number>
698
699Apply Gaussian Blurr with the specified radius to the transparent
700background image; option B<-blr>.
610 701
611=item B<scrollColor:> I<colour> 702=item B<scrollColor:> I<colour>
612 703
613Use the specified colour for the scrollbar [default #B2B2B2]. 704Use the specified colour for the scrollbar [default #B2B2B2].
614 705
620=item B<borderColor:> I<colour> 711=item B<borderColor:> I<colour>
621 712
622The colour of the border around the text area and between the scrollbar 713The colour of the border around the text area and between the scrollbar
623and the text. 714and the text.
624 715
625=item B<backgroundPixmap:> I<file[;geom]> 716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626 717
627Use the specified XPM file (note the `.xpm' extension is optional) for 718Use the specified image file for the background and also
628the background and also optionally specify its scaling with a geometry 719optionally specify its scaling with a geometry string B<WxH+X+Y>,
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
631centre (percent). A scale of 0 displays the image with tiling. A scale 722centre (percent). A scale of 0 displays the image with tiling. A scale
632of 1 displays the image without any scaling. A scale of 2 to 9 723of 1 displays the image without any scaling. A scale of 2 to 9 specifies
633specifies an integer number of images in that direction. No image will 724an integer number of images in that direction. No image will be magnified
634be magnified beyond 10 times its original size. The maximum permitted 725beyond 10 times its original size. The maximum permitted scale is 1000.
635scale is 1000. [default 0x0+50+50] 726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are:
728
729 tile force background image to be tiled and not scaled. Equivalent to 0x0
730 propscale will scale image keeping proportions
731 auto will scale image to match window size. Equivalent to 100x100
732 hscale will scale image horizontally to the window size
733 vscale will scale image vertically to the window size
734 scale will scale image to match window size
735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves
737
738If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any
740other blending type, specified with B<-blt "type"> option.
636 741
637=item B<path:> I<path> 742=item B<path:> I<path>
638 743
639Specify the colon-delimited search path for finding XPM files. 744Specify the colon-delimited search path for finding background image files.
640 745
641=item B<font:> I<fontlist> 746=item B<font:> I<fontlist>
642 747
643Select the fonts to be used. This is a comma separated list of font names 748Select the fonts to be used. This is a comma separated list of font names
644that are checked in order when trying to find glyphs for characters. The 749that are checked in order when trying to find glyphs for characters. The
701text font will being used for the given style. 806text font will being used for the given style.
702 807
703=item B<intensityStyles:> I<boolean> 808=item B<intensityStyles:> I<boolean>
704 809
705When font styles are not enabled, or this option is enabled (B<True>, 810When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 811option B<-is>, the default), bold/blink font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 812intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 813option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 814reachable.
710
711=item B<selectstyle:> I<mode>
712
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is
714xterm style with 2.20 old word selection, or anything else which gives
715xterm style selection.
716 815
717=item B<scrollstyle:> I<mode> 816=item B<scrollstyle:> I<mode>
718 817
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 818Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite. 819the author's favourite.
734=item B<mapAlert:> I<boolean> 833=item B<mapAlert:> I<boolean>
735 834
736B<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
737de-iconify (map) on receipt of a bell character [default]. 836de-iconify (map) on receipt of a bell character [default].
738 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
739=item B<visualBell:> I<boolean> 843=item B<visualBell:> I<boolean>
740 844
741B<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>.
742B<False>: no visual bell [default]; option B<+vb>. 846B<False>: no visual bell [default]; option B<+vb>.
743 847
764Example: 868Example:
765 869
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 871
768This 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
769everytime you hit C<Print>. 873every time you hit C<Print>.
770 874
771=item B<scrollBar:> I<boolean> 875=item B<scrollBar:> I<boolean>
772 876
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 878disable the scrollbar; option B<+sb>.
796 900
797=item B<scrollWithBuffer:> I<boolean> 901=item B<scrollWithBuffer:> I<boolean>
798 902
799B<True>: scroll with scrollback buffer when tty receives new lines (and 903B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 904B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 905with scrollback buffer when tty receives new lines; option B<+sw>.
802 906
803=item B<scrollTtyKeypress:> I<boolean> 907=item B<scrollTtyKeypress:> I<boolean>
804 908
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 909B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 910are those which are intercepted by rxvt-unicode for special handling and
837=item B<termName:> I<termname> 941=item B<termName:> I<termname>
838 942
839Specifies the terminal type name to be set in the B<TERM> environment 943Specifies the terminal type name to be set in the B<TERM> environment
840variable; option B<-tn>. 944variable; option B<-tn>.
841 945
842=item B<linespace:> I<number> 946=item B<lineSpace:> I<number>
843 947
844Specifies number of lines (pixel height) to insert between each row of 948Specifies number of lines (pixel height) to insert between each row of
845the display [default 0]; option B<-lsp>. 949the display [default 0]; option B<-lsp>.
846 950
847=item B<meta8:> I<boolean> 951=item B<meta8:> I<boolean>
896pressed. If unset it will send the sequence traditionally associated 1000pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 1001with the B<Execute> key.
898 1002
899=item B<cutchars:> I<string> 1003=item B<cutchars:> I<string>
900 1004
901The characters used as delimiters for double-click word selection. 1005The characters used as delimiters for double-click word selection
1006(whitespace delimiting is added automatically if resource is given).
902 1007
903When the selection extension is in use (the default if compiled in, see 1008When the perl selection extension is in use (the default if compiled
904the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1009in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
905will be created (if the resource exists, otherwise, no regex will be 1010characters will be created (if the resource exists, otherwise, no regex
906created). In this mode, characters outside ISO-8859-1 can be used. 1011will be created). In this mode, characters outside ISO-8859-1 can be used.
907 1012
908When the selection extension is not used, only ISO-8859-1 characters can 1013When the selection extension is not used, only ISO-8859-1 characters can
909be used. If not specified, the built-in default is used: 1014be used. If not specified, the built-in default is used:
910 1015
911B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1016B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
912 1017
913=item B<preeditType:> I<style> 1018=item B<preeditType:> I<style>
914 1019
915B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1020B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
916 1021
970 1075
971Turn on/off secondary screen (default enabled). 1076Turn on/off secondary screen (default enabled).
972 1077
973=item B<secondaryScroll:> I<boolean> 1078=item B<secondaryScroll:> I<boolean>
974 1079
975Turn on/off secondary screen scroll (default enabled). If the this 1080Turn on/off secondary screen scroll (default enabled). If this
976option is enabled, scrolls on the secondary screen will change the 1081option is enabled, scrolls on the secondary screen will change the
977scrollback buffer and switching to/from the secondary screen will 1082scrollback buffer and switching to/from the secondary screen will
978instead scroll the screen up. 1083instead scroll the screen up.
979 1084
980=item B<hold>: I<boolean> 1085=item B<hold>: I<boolean>
1004searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1109searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1005omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1110omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1006keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1111keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1007performed in an exact manner; however, the closest match is assured. 1112performed in an exact manner; however, the closest match is assured.
1008 1113
1009I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1114I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1010C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1115number), see RESOURCES in C<man 7 X> for futher details.
1011C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1012C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1013can start or end with whitespace.
1014
1015Please note that you need to double the C<\> in resource files, as
1016Xlib itself does it's own de-escaping (you can use C<\033> instead of
1017C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1018processing).
1019 1116
1020You can define a range of keysyms in one shot by providing a I<string> 1117You can define a range of keysyms in one shot by providing a I<string>
1021with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1118with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1022should be a character not used by the strings. 1119should be a character not used by the strings.
1023 1120
1024Its usage can be demonstrated by an example: 1121Its usage can be demonstrated by an example:
1025 1122
1026 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1123 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1090example, C<default,-selection> will use all the default extension except 1187example, C<default,-selection> will use all the default extension except
1091C<selection>. 1188C<selection>.
1092 1189
1093Extension names can also be followed by an argument in angle brackets 1190Extension names can also be followed by an argument in angle brackets
1094(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1191(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1095searchable scorllback to Alt/Meta-s). Mentioning the same extension 1192searchable scrollback to Alt/Meta-s). Mentioning the same extension
1096multiple times with different arguments will pass multiple arguments to 1193multiple times with different arguments will pass multiple arguments to
1097the extension. 1194the extension.
1098 1195
1099Each extension is looked up in the library directories, loaded if 1196Each extension is looked up in the library directories, loaded if
1100necessary, and bound to the current terminal instance. 1197necessary, and bound to the current terminal instance.
1136(default: C<M-s>). 1233(default: C<M-s>).
1137 1234
1138=item B<urlLauncher>: I<string> 1235=item B<urlLauncher>: I<string>
1139 1236
1140Specifies the program to be started with a URL argument. Used by the 1237Specifies the program to be started with a URL argument. Used by the
1141C<selection-popup> and C<mark-urls> perl extensions. 1238C<selection-popup> and C<matcher> perl extensions.
1142 1239
1143=item B<transient-for>: I<windowid> 1240=item B<transient-for>: I<windowid>
1144 1241
1145Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1242Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1146 1243
1147=item B<override-redirect>: I<boolean> 1244=item B<override-redirect>: I<boolean>
1148 1245
1149Compile I<frills>: Sets override-redirect for the terminal window, making 1246Compile I<frills>: Sets override-redirect for the terminal window, making
1150it almost invisible to window managers; option B<-override-redirect>. 1247it almost invisible to window managers; option B<-override-redirect>.
1248
1249=item B<iso14755_52:> I<boolean>
1250
1251Turn on/off ISO 14755 5.2 mode (default enabled).
1151 1252
1152=back 1253=back
1153 1254
1154=head1 THE SCROLLBAR 1255=head1 THE SCROLLBAR
1155 1256
1174application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1275application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1175(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1276(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1176up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1277up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1177respectively. 1278respectively.
1178 1279
1179=head1 TEXT SELECTION AND INSERTION 1280=head1 THE SELECTION: SELECTING AND PASTING TEXT
1180 1281
1181The behaviour of text selection and insertion mechanism is similar to 1282The behaviour of text selection and insertion/pasting mechanism is similar
1182I<xterm>(1). 1283to I<xterm>(1).
1183 1284
1184=over 4 1285=over 4
1185 1286
1186=item B<Selection>: 1287=item B<Selecting>:
1187 1288
1188Left click at the beginning of the region, drag to the end of the region 1289Left click at the beginning of the region, drag to the end of the region
1189and release; Right click to extend the marked region; Left double-click 1290and release; Right click to extend the marked region; Left double-click
1190to select a word; Left triple-click to select the entire logical line 1291to select a word; Left triple-click to select the entire logical line
1191(which can span multiple screen lines), unless modified by resource 1292(which can span multiple screen lines), unless modified by resource
1195(Compile: I<frills>) will create a rectangular selection instead of a 1296(Compile: I<frills>) will create a rectangular selection instead of a
1196normal one. In this mode, every selected row becomes its own line in the 1297normal one. In this mode, every selected row becomes its own line in the
1197selection, and trailing whitespace is visually underlined and removed from 1298selection, and trailing whitespace is visually underlined and removed from
1198the selection. 1299the selection.
1199 1300
1200=item B<Insertion>: 1301=item B<Pasting>:
1201 1302
1202Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1303Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1203window causes the value of the PRIMARY selection (or CLIPBOARD with the 1304window causes the value of the PRIMARY selection (or CLIPBOARD with the
1204Meta modifier) to be inserted as if it had been typed on the keyboard. 1305B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1205 1306
1206Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1307Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1207inserted too. 1308inserted too.
1208 1309
1209=back 1310=back
1226 1327
1227=head1 ISO 14755 SUPPORT 1328=head1 ISO 14755 SUPPORT
1228 1329
1229ISO 14755 is a standard for entering and viewing unicode characters 1330ISO 14755 is a standard for entering and viewing unicode characters
1230and character codes using the keyboard. It consists of 4 parts. The 1331and character codes using the keyboard. It consists of 4 parts. The
1231first part is available rxvt-unicode has been compiled with 1332first part is available if rxvt-unicode has been compiled with
1232C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1333C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1233with C<--enable-iso14755>. 1334with C<--enable-iso14755>.
1234 1335
1235=over 4 1336=over 4
1236 1337
1256This mode lets you input characters representing the keycap symbols of 1357This mode lets you input characters representing the keycap symbols of
1257your keyboard, if representable in the current locale encoding. 1358your keyboard, if representable in the current locale encoding.
1258 1359
1259Start by pressing C<Control> and C<Shift> together, then releasing 1360Start by pressing C<Control> and C<Shift> together, then releasing
1260them. The next special key (cursor keys, home etc.) you enter will not 1361them. The next special key (cursor keys, home etc.) you enter will not
1261invoke it's usual function but instead will insert the corresponding 1362invoke its usual function but instead will insert the corresponding
1262keycap symbol. The symbol will only be entered when the key has been 1363keycap symbol. The symbol will only be entered when the key has been
1263released, otherwise pressing e.g. C<Shift> would enter the symbol for 1364released, otherwise pressing e.g. C<Shift> would enter the symbol for
1264C<ISO Level 2 Switch>, although your intention might have been to enter a 1365C<ISO Level 2 Switch>, although your intention might have been to enter a
1265reverse tab (Shift-Tab). 1366reverse tab (Shift-Tab).
1266 1367
1299=head1 COLORS AND GRAPHICS 1400=head1 COLORS AND GRAPHICS
1300 1401
1301In addition to the default foreground and background colours, 1402In addition to the default foreground and background colours,
1302B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1403B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1303high-intensity bold/blink versions of the same). Here is a list of the 1404high-intensity bold/blink versions of the same). Here is a list of the
1304colours with their B<rgb.txt> names. 1405colours with their names.
1305 1406
1306=begin table 1407=begin table
1307 1408
1308 B<color0> (black) = Black 1409 B<color0> (black) = Black
1309 B<color1> (red) = Red3 1410 B<color1> (red) = Red3
1329It is also possible to specify the colour values of B<foreground>, 1430It is also possible to specify the colour values of B<foreground>,
1330B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1431B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1331a number 0-15, as a convenient shorthand to reference the colour name of 1432a number 0-15, as a convenient shorthand to reference the colour name of
1332color0-color15. 1433color0-color15.
1333 1434
1435In addition to the colours defined above, @@RXVT_NAME@@ offers an
1436additional 72 colours. The first 64 of those (with indices 16 to 79)
1437consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
143816>), followed by 8 additional shades of gray (with indices 80 to 87).
1439
1440Together, all those colours implement the 88 colour xterm colours. Only
1441the first 16 can be changed using resources currently, the rest can only
1442be changed via command sequences ("escape codes").
1443
1334Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1444Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1335always swapping the foreground/background colours. This is in contrast to 1445always swapping the foreground/background colours. This is in contrast to
1336I<xterm>(1) where the colours are only swapped if they have not otherwise 1446I<xterm>(1) where the colours are only swapped if they have not otherwise
1337been specified. For example, 1447been specified. For example,
1338 1448
1343would yield White on Black, while on I<xterm>(1) it would yield Black 1453would yield White on Black, while on I<xterm>(1) it would yield Black
1344on White. 1454on White.
1345 1455
1346=back 1456=back
1347 1457
1458=head2 ALPHA CHANNEL SUPPORT
1459
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1462(recommended, but B<MUST> have 4 digits/component) colour specifications,
1463in addition to the ones provided by X, where the additional A component
1464specifies opacity (alpha) values. The minimum value of C<0> is completely
1465transparent). You can also prefix any color with C<[percent]>, where
1466C<percent> is a decimal percentage (0-100) that specifies the opacity of
1467the color, where C<0> is completely transparent and C<100> is completelxy
1468opaque.
1469
1470You probably need to specify B<"-depth 32">, too, and have the luck that
1471your X-server uses ARGB pixel layout, as X is far from just supporting
1472ARGB visuals out of the box, and rxvt-unicode just fudges around.
1473
1474For example, the following selects an almost completely transparent red
1475background, and an almost opaque pink foreground:
1476
1477 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1478
1479I<Please note that transparency of any kind if completely unsupported by
1480the author. Don't bug him with installation questions!>
1481
1348=head1 ENVIRONMENT 1482=head1 ENVIRONMENT
1349 1483
1350B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1484B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1351 1485
1352=over 4 1486=over 4
1353 1487
1354=item B<TERM> 1488=item B<TERM>
1355 1489
1356Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1490Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1357resources or on the commandline. 1491resources or on the command line.
1358 1492
1359=item B<COLORTERM> 1493=item B<COLORTERM>
1360 1494
1361Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1495Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1362compiled with XPM support, and optionally with the added extension 1496compiled with background image support, and optionally with the added
1363C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1497extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1498screen.
1364 1499
1365=item B<COLORFGBG> 1500=item B<COLORFGBG>
1366 1501
1367Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1502Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1368the colour code used as default foreground/text colour (or the string 1503the colour code used as default foreground/text colour (or the string
1369C<default> to indicate that the default-colour escape sequence is to be 1504C<default> to indicate that the default-colour escape sequence is to be
1370used), C<bg> is the colour code used as default background colour (or the 1505used), C<bg> is the colour code used as default background colour (or the
1371string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1506string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1372was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1507was compiled with background image support. Libraries like C<ncurses>
1373(and do) use this information to optimize screen output. 1508and C<slang> can (and do) use this information to optimize screen output.
1374 1509
1375=item B<WINDOWID> 1510=item B<WINDOWID>
1376 1511
1377Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1512Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1378window, which usually has subwindows for the scrollbar, the terminal 1513window, which usually has subwindows for the scrollbar, the terminal
1384C<--with-terminfo=PATH>. 1519C<--with-terminfo=PATH>.
1385 1520
1386=item B<DISPLAY> 1521=item B<DISPLAY>
1387 1522
1388Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1523Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1389display in it's child processes. 1524display in its child processes.
1390 1525
1391=item B<SHELL> 1526=item B<SHELL>
1392 1527
1393The shell to be used for command execution, defaults to C</bin/sh>. 1528The shell to be used for command execution, defaults to C</bin/sh>.
1394 1529
1436 1571
1437=item Project Coordinator 1572=item Project Coordinator
1438 1573
1439Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1574Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1440 1575
1441L<http://software.schmorp.de/#rxvt-unicode> 1576L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1442 1577
1443=back 1578=back
1444 1579
1445=head1 AUTHORS 1580=head1 AUTHORS
1446 1581
1469Project Coordinator (changes.txt 2.21a to 2.4.5) 1604Project Coordinator (changes.txt 2.21a to 2.4.5)
1470 1605
1471=item Geoff Wing L<< <gcw@pobox.com> >> 1606=item Geoff Wing L<< <gcw@pobox.com> >>
1472 1607
1473Rewrote screen display and text selection routines. 1608Rewrote screen display and text selection routines.
1474 1609
1475Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1610Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1476 1611
1477=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1612=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1478 1613
1479Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1614Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines