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.93 by root, Wed Jan 11 23:08:54 2006 UTC vs.
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal 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 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display 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 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its 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 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and 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 57without 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 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114
115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
109 118
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 120
112Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
123
124I<Please address all transparency related issues to Sasha Vasko at
125sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 126
115=item B<-fade> I<number> 127=item B<-fade> I<number>
116 128
117Fade the text by the given percentage when focus is lost. Small values 129Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 130fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 131colour; resource B<fading>.
120 132
121=item B<-fadecolor> I<colour> 133=item B<-fadecolor> I<colour>
122 134
123Fade to this colour when fading is used (see B<-fade>). The default colour 135Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 136is opaque black. resource B<fadeColor>.
125 137
126=item B<-tint> I<colour> 138=item B<-tint> I<colour>
127 139
128Tint the transparent background pixmap with the given colour when 140Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 141transparency is enabled with B<-tr> or B<-ip>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 142non-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 143used to brighten or darken the image in addition to tinting it.
144Please note that certain tint colours can be applied on the server-side,
145thus yielding performance gain of two orders of magnitude. These colours are:
146blue, red, green, cyan, magenta, yellow, and those close to them; resource
132I<tintColor>. Example: 147I<tintColor>. Example:
133 148
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 149 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 150
136=item B<-sh> 151=item B<-sh> I<number>
137 152
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 153Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 154background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 155resource I<shading>.
156
157=item B<-blt> I<string>
158
159Specify background blending type. If background pixmap is specified
160at the same time as transparency - such pixmap will be blended over
161transparency image, using method specified. Supported values are :
162B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165alpha-blending; resource I<blendType>.
166
167=item B<-blr> I<HxV>
168
169Apply Gaussian Blur with the specified radii to the transparent
170background image. If single number is specified - both vertical and
171horizontal radii are considered to be the same. Setting one of the
172radii to 1 and another to a large number creates interesting effects
173on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
141 174
142=item B<-bg> I<colour> 175=item B<-bg> I<colour>
143 176
144Window background colour; resource B<background>. 177Window background colour; resource B<background>.
145 178
147 180
148Window foreground colour; resource B<foreground>. 181Window foreground colour; resource B<foreground>.
149 182
150=item B<-pixmap> I<file[;geom]> 183=item B<-pixmap> I<file[;geom]>
151 184
152Compile I<XPM>: Specify XPM file for the background and also optionally 185Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 186optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 187add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 188command-line; for more details see resource B<backgroundPixmap>.
156 189
157=item B<-cr> I<colour> 190=item B<-cr> I<colour>
158 191
159The cursor colour; resource B<cursorColor>. 192The cursor colour; resource B<cursorColor>.
160 193
172resource B<borderColor>. 205resource B<borderColor>.
173 206
174=item B<-fn> I<fontlist> 207=item B<-fn> I<fontlist>
175 208
176Select the fonts to be used. This is a comma separated list of font names 209Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 210that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 211first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 212smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 213font list is always appended to it. See resource B<font> for more details.
181 214
182In short, to specify an X11 core font, just specify it's name or prefix it 215In 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:>, 216with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 217e.g.:
185 218
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 219 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 220 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
297 330
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 331Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 332if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 333decorations; resource B<borderLess>.
301 334
335=item B<-override-redirect>
336
337Compile I<frills>: Sets override-redirect on the window; resource
338B<override-redirect>.
339
302=item B<-sbg> 340=item B<-sbg>
303 341
304Compile I<frills>: Disable the usage of the built-in block graphics/line 342Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 343drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs; 344this if you have a good font and want to use its block graphic glyphs;
308 346
309=item B<-lsp> I<number> 347=item B<-lsp> I<number>
310 348
311Compile I<frills>: Lines (pixel height) to insert between each row of 349Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 350the display. Useful to work around font rendering problems; resource
313B<linespace>. 351B<lineSpace>.
314 352
315=item B<-tn> I<termname> 353=item B<-tn> I<termname>
316 354
317This option specifies the name of the terminal type to be set in the 355This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 356B<TERM> environment variable. This terminal type must exist in the
372for more info. 410for more info.
373 411
374=item B<-tcw> 412=item B<-tcw>
375 413
376Change the meaning of triple-click selection with the left mouse 414Change the meaning of triple-click selection with the left mouse
415button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 416in-use. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>. 417end of the logical line only. resource B<tripleclickwords>.
379 418
380=item B<-insecure> 419=item B<-insecure>
381 420
382Enable "insecure" mode, which currently enables most of the escape 421Enable "insecure" mode, which currently enables most of the escape
410 449
411Remap a key symbol. See resource B<keysym>. 450Remap a key symbol. See resource B<keysym>.
412 451
413=item B<-embed> I<windowid> 452=item B<-embed> I<windowid>
414 453
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 454Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 455which enables applications to easily embed a terminal.
417 456
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 457Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 458shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 459quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 462The window will not be destroyed when @@RXVT_NAME@@ exits.
424 463
425It might be useful to know that @@RXVT_NAME@@ will not close file 464It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 465descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 466can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 467terminal. This works regardless of whether the C<-embed> option was used or
429not. 468not.
430 469
431Here is a short Gtk2-perl snippet that illustrates how this option can be 470Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 471used (a longer example is in F<doc/embed>):
433 472
438 }); 477 });
439 478
440=item B<-pty-fd> I<file descriptor> 479=item B<-pty-fd> I<file descriptor>
441 480
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 481Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 482pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 483useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 484without having to run a program within it.
446 485
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 486If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 487entries and will not tinker with pty/tty permissions - you have to do that
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 539check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 540extensions not documented here):
502 541
503=over 4 542=over 4
504 543
544=item B<depth:> I<bitdepth>
545
546Compile I<xft>: Attempt to find a visual with the given bit depth;
547option B<-depth>.
548
505=item B<geometry:> I<geom> 549=item B<geometry:> I<geom>
506 550
507Create the window with the specified X window geometry [default 80x24]; 551Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 552option B<-geometry>.
509 553
545Use the specified colour to display underlined characters when the 589Use the specified colour to display underlined characters when the
546foreground colour is the default. 590foreground colour is the default.
547 591
548=item B<colorRV:> I<colour> 592=item B<colorRV:> I<colour>
549 593
550Use the specified colour as the background for reverse video 594Use the specified colour as the background for reverse video characters
551characters. 595when OPTION_HC is disabled (--disable-frills).
552 596
553=item B<underlineColor:> I<colour> 597=item B<underlineColor:> I<colour>
554 598
555If set, use the specified colour as the colour for the underline 599If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 600itself. If unset, use the foreground colour.
572option B<-rv>. B<False>: regular screen colours [default]; option 616option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 617B<+rv>. See note in B<COLORS AND GRAPHICS> section.
574 618
575=item B<jumpScroll:> I<boolean> 619=item B<jumpScroll:> I<boolean>
576 620
577B<True>: specify that jump scrolling should be used. When scrolling 621B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, fewer screen updates are performed [default]; option B<-j>. 622of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
623has been read, resulting in fewer updates while still displaying every
624received line; option B<-j>.
625
579B<False>: specify that smooth scrolling should be used; option B<+j>. 626B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
627force a screen refresh on each new line it received; option B<+j>.
628
629=item B<skipScroll:> I<boolean>
630
631B<True>: (the default) specify that skip scrolling should be used. When
632receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
633(around 60 times per second), resulting in far fewer updates. This can
634result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
635option B<-ss>.
636
637B<False>: specify that everything is to be displayed, even
638if the refresh is too fast for the human eye to read anything (or the
639monitor to display anything); option B<+ss>.
580 640
581=item B<inheritPixmap:> I<boolean> 641=item B<inheritPixmap:> I<boolean>
582 642
583B<True>: make the background inherit the parent windows' pixmap, giving 643B<True>: make the background inherit the parent windows' pixmap, giving
584artificial transparency. B<False>: do not inherit the parent windows' 644artificial transparency. B<False>: do not inherit the parent windows'
585pixmap. 645pixmap.
586 646
647I<Please note that transparency of any kind if completely unsupported by
648the author. Don't bug him with installation questions!>
649
587=item B<fading:> I<number> 650=item B<fading:> I<number>
588 651
589Fade the text by the given percentage when focus is lost; option B<-fade>. 652Fade the text by the given percentage when focus is lost; option B<-fade>.
590 653
591=item B<fadeColor:> I<colour> 654=item B<fadeColor:> I<colour>
598Tint the transparent background pixmap with the given colour; option 661Tint the transparent background pixmap with the given colour; option
599B<-tint>. 662B<-tint>.
600 663
601=item B<shading:> I<number> 664=item B<shading:> I<number>
602 665
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 666Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604image in addition to tinting it. 667in addition to tinting it; option B<-sh>.
668
669=item B<blendType:> I<string>
670
671Specify background blending type; option B<-blt>.
672
673=item B<blurRadius:> I<number>
674
675Apply Gaussian Blurr with the specified radius to the transparent
676background image; option B<-blr>.
605 677
606=item B<scrollColor:> I<colour> 678=item B<scrollColor:> I<colour>
607 679
608Use the specified colour for the scrollbar [default #B2B2B2]. 680Use the specified colour for the scrollbar [default #B2B2B2].
609 681
617The colour of the border around the text area and between the scrollbar 689The colour of the border around the text area and between the scrollbar
618and the text. 690and the text.
619 691
620=item B<backgroundPixmap:> I<file[;geom]> 692=item B<backgroundPixmap:> I<file[;geom]>
621 693
622Use the specified XPM file (note the `.xpm' extension is optional) for 694Use the specified image file for the background and also optionally
623the background and also optionally specify its scaling with a geometry 695specify its scaling with a geometry string B<WxH+X+Y>,
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 696in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 697and B<"X" / "Y"> locate the image centre (percent).
626centre (percent). A scale of 0 displays the image with tiling. A scale 698A scale of 0 displays the image with tiling. A scale of 1 displays the
627of 1 displays the image without any scaling. A scale of 2 to 9 699image without any scaling. A scale of 2 to 9 specifies an integer
628specifies an integer number of images in that direction. No image will 700number of images in that direction. No image will be magnified beyond
629be magnified beyond 10 times its original size. The maximum permitted 70110 times its original size. The maximum permitted scale is 1000.
630scale is 1000. [default 0x0+50+50] 702Special string of B<"auto"> used as a geometry will cause image to be
631 703automatically scaled to match window size.
632=item B<menu:> I<file[;tag]> 704If used in conjunction with B<-tr> option - specified pixmap will be
633 705blended over transparency image using either alpha-blending, or any
634Read in the specified menu file (note the `.menu' extension is 706other blending type, specified with B<-blt "type"> option.
635optional) and also optionally specify a starting tag to find. See the 707[default 0x0+50+50]
636reference documentation for details on the syntax for the menuBar.
637 708
638=item B<path:> I<path> 709=item B<path:> I<path>
639 710
640Specify the colon-delimited search path for finding files (XPM and 711Specify the colon-delimited search path for finding background image files.
641menus), in addition to the paths specified by the B<RXVTPATH> and
642B<PATH> environment variables.
643 712
644=item B<font:> I<fontlist> 713=item B<font:> I<fontlist>
645 714
646Select the fonts to be used. This is a comma separated list of font 715Select the fonts to be used. This is a comma separated list of font names
647names that are used in turn when trying to display Unicode characters. 716that are checked in order when trying to find glyphs for characters. The
648The first font defines the cell size for characters; other fonts might 717first font defines the cell size for characters; other fonts might be
649be smaller, but not larger. A reasonable default font list is always 718smaller, but not (in general) larger. A (hopefully) reasonable default
650appended to it; option B<-fn>. 719font list is always appended to it; option B<-fn>.
651 720
652Each font can either be a standard X11 core font (XLFD) name, with 721Each font can either be a standard X11 core font (XLFD) name, with
653optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 722optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
654 723
655In addition, each font can be prefixed with additional hints and 724In addition, each font can be prefixed with additional hints and
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 726hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 727fonts.
659 728
660For example, this font resource 729For example, this font resource
661 730
662 URxvt*font: 9x15bold,\ 731 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 732 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
664 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 733 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 734 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 735 xft:Code2000:antialias=false
667 736
705 774
706=item B<intensityStyles:> I<boolean> 775=item B<intensityStyles:> I<boolean>
707 776
708When font styles are not enabled, or this option is enabled (B<True>, 777When font styles are not enabled, or this option is enabled (B<True>,
709option B<-is>, the default), bold and italic font styles imply high 778option B<-is>, the default), bold and italic font styles imply high
710intensity foreground/backround colours. Disabling this option (B<False>, 779intensity foreground/background colours. Disabling this option (B<False>,
711option B<+is>) disables this behaviour, the high intensity colours are not 780option B<+is>) disables this behaviour, the high intensity colours are not
712reachable. 781reachable.
713 782
714=item B<selectstyle:> I<mode> 783=item B<selectstyle:> I<mode>
715 784
716Set mouse selection style to B<old> which is 2.20, B<oldword> which is 785Set mouse selection style to B<old> which is 2.20, B<oldword> which
717xterm style with 2.20 old word selection, or anything else which gives 786is xterm style with 2.20 old word selection, or anything else which
718xterm style selection. 787gives xterm style selection. Only effective when the original (non-perl)
788selection code is in use.
719 789
720=item B<scrollstyle:> I<mode> 790=item B<scrollstyle:> I<mode>
721 791
722Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 792Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
723the author's favourite. 793the author's favourite.
737=item B<mapAlert:> I<boolean> 807=item B<mapAlert:> I<boolean>
738 808
739B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 809B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
740de-iconify (map) on receipt of a bell character [default]. 810de-iconify (map) on receipt of a bell character [default].
741 811
812=item B<urgentOnBell:> I<boolean>
813
814B<True>: set the urgency hint for the wm on receipt of a bell character.
815B<False>: do not set the urgency hint [default].
816
742=item B<visualBell:> I<boolean> 817=item B<visualBell:> I<boolean>
743 818
744B<True>: use visual bell on receipt of a bell character; option B<-vb>. 819B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745B<False>: no visual bell [default]; option B<+vb>. 820B<False>: no visual bell [default]; option B<+vb>.
746 821
764 839
765The string will be interpreted as if typed into the shell as-is. 840The string will be interpreted as if typed into the shell as-is.
766 841
767Example: 842Example:
768 843
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 844 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 845
771This creates a new file in your home directory with the screen contents 846This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 847every time you hit C<Print>.
773 848
774=item B<scrollBar:> I<boolean> 849=item B<scrollBar:> I<boolean>
775 850
776B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 851B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777disable the scrollbar; option B<+sb>. 852disable the scrollbar; option B<+sb>.
799 874
800=item B<scrollWithBuffer:> I<boolean> 875=item B<scrollWithBuffer:> I<boolean>
801 876
802B<True>: scroll with scrollback buffer when tty receives new lines (and 877B<True>: scroll with scrollback buffer when tty receives new lines (and
803B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 878B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
804with scrollback buffer when tty recieves new lines; option B<+sw>. 879with scrollback buffer when tty receives new lines; option B<+sw>.
805 880
806=item B<scrollTtyKeypress:> I<boolean> 881=item B<scrollTtyKeypress:> I<boolean>
807 882
808B<True>: scroll to bottom when a non-special key is pressed. Special keys 883B<True>: scroll to bottom when a non-special key is pressed. Special keys
809are those which are intercepted by rxvt-unicode for special handling and 884are those which are intercepted by rxvt-unicode for special handling and
840=item B<termName:> I<termname> 915=item B<termName:> I<termname>
841 916
842Specifies the terminal type name to be set in the B<TERM> environment 917Specifies the terminal type name to be set in the B<TERM> environment
843variable; option B<-tn>. 918variable; option B<-tn>.
844 919
845=item B<linespace:> I<number> 920=item B<lineSpace:> I<number>
846 921
847Specifies number of lines (pixel height) to insert between each row of 922Specifies number of lines (pixel height) to insert between each row of
848the display [default 0]; option B<-lsp>. 923the display [default 0]; option B<-lsp>.
849 924
850=item B<meta8:> I<boolean> 925=item B<meta8:> I<boolean>
899pressed. If unset it will send the sequence traditionally associated 974pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 975with the B<Execute> key.
901 976
902=item B<cutchars:> I<string> 977=item B<cutchars:> I<string>
903 978
904The characters used as delimiters for double-click word selection. The 979The characters used as delimiters for double-click word selection
905built-in default: 980(whitespace delimiting is added automatically if resource is given).
981
982When the perl selection extension is in use (the default if compiled
983in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
984characters will be created (if the resource exists, otherwise, no regex
985will be created). In this mode, characters outside ISO-8859-1 can be used.
986
987When the selection extension is not used, only ISO-8859-1 characters can
988be used. If not specified, the built-in default is used:
906 989
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 990B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
908 991
909=item B<preeditType:> I<style> 992=item B<preeditType:> I<style>
910 993
946default. (Note that many other terminals, including xterm, have these 1029default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 1030sequences enabled by default, which doesn't make it safer, though).
948 1031
949You can enable them by setting this boolean resource or specifying 1032You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 1033B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 1034locale, findfont, icon label and window title requests.
952menubar dispatch.
953 1035
954=item B<modifier:> I<modifier> 1036=item B<modifier:> I<modifier>
955 1037
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1038Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
957B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1039B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 1043
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1044Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 1045character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 1046in the entry on B<keysym> following.
965 1047
966=item B<secondaryScreen:> I<bool> 1048=item B<secondaryScreen:> I<boolean>
967 1049
968Turn on/off secondary screen (default enabled). 1050Turn on/off secondary screen (default enabled).
969 1051
970=item B<secondaryScroll:> I<bool> 1052=item B<secondaryScroll:> I<boolean>
971 1053
972Turn on/off secondary screen scroll (default enabled). If the this 1054Turn on/off secondary screen scroll (default enabled). If this
973option is enabled, scrolls on the secondary screen will change the 1055option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 1056scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 1057instead scroll the screen up.
976 1058
977=item B<hold>: I<bool> 1059=item B<hold>: I<boolean>
978 1060
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1061Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 1062will not immediately destroy its window when the program executed within
981it exits. Instead, it will wait till it is being killed or closed by the 1063it exits. Instead, it will wait till it is being killed or closed by the
982user. 1064user.
1005 1087
1006I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1088I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1007C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1089C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1008C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1090C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1009C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1091C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1010can start or end with whitespace. 1092can start or end with whitespace. B<This feature is deprecated and will
1093be removed>.
1011 1094
1012Please note that you need to double the C<\> in resource files, as 1095Please note that you need to double the C<\> in resource files, as
1013Xlib itself does it's own de-escaping (you can use C<\033> instead of 1096Xlib itself does its own de-escaping (you can use C<\033> instead of
1014C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1097C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015processing). 1098processing).
1016 1099
1017You can define a range of keysyms in one shot by providing a I<string> 1100You can define a range of keysyms in one shot by providing a I<string>
1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1101with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019should be a character not used by the strings. 1102should be a character not used by the strings.
1020 1103
1021Its usage can be demonstrated by an example: 1104Its usage can be demonstrated by an example:
1022 1105
1023 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1106 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1087example, C<default,-selection> will use all the default extension except 1170example, C<default,-selection> will use all the default extension except
1088C<selection>. 1171C<selection>.
1089 1172
1090Extension names can also be followed by an argument in angle brackets 1173Extension names can also be followed by an argument in angle brackets
1091(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1174(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092searchable scorllback to Alt/Meta-s). Mentioning the same extension 1175searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093multiple times with different arguments will pass multiple arguments to 1176multiple times with different arguments will pass multiple arguments to
1094the extension. 1177the extension.
1095 1178
1096Each extension is looked up in the library directories, loaded if 1179Each extension is looked up in the library directories, loaded if
1097necessary, and bound to the current terminal instance. 1180necessary, and bound to the current terminal instance.
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1198F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1199will be ignored when running setuid/setgid.
1117 1200
1118See the @@RXVT_NAME@@perl(3) manpage. 1201See the @@RXVT_NAME@@perl(3) manpage.
1119 1202
1203=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1204
1205Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1206details.
1207
1208=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1209
1210Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1211for details.
1212
1213=item B<searchable-scrollback:> I<keysym>
1214
1215Sets the hotkey that starts the incremental scrollback buffer search
1216(default: C<M-s>).
1217
1120=item B<urlLauncher>: I<string> 1218=item B<urlLauncher>: I<string>
1121 1219
1122Specifies the program to be started with a URL argument. Used by the 1220Specifies the program to be started with a URL argument. Used by the
1123C<selection-popup> and C<mark-urls> perl extensions. 1221C<selection-popup> and C<matcher> perl extensions.
1124 1222
1125=item B<transient-for>: I<windowid> 1223=item B<transient-for>: I<windowid>
1126 1224
1127Sets the WM_TRANSIENT_FOR property to the given window iw. 1225Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1226
1227=item B<override-redirect>: I<boolean>
1228
1229Compile I<frills>: Sets override-redirect for the terminal window, making
1230it almost invisible to window managers; option B<-override-redirect>.
1231
1232=item B<iso14755_52:> I<boolean>
1233
1234Turn on/off ISO 14755 5.2 mode (default enabled).
1128 1235
1129=back 1236=back
1130 1237
1131=head1 THE SCROLLBAR 1238=head1 THE SCROLLBAR
1132 1239
1151application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1258application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1152(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1259(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1153up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1260up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1154respectively. 1261respectively.
1155 1262
1156=head1 TEXT SELECTION AND INSERTION 1263=head1 THE SELECTION: SELECTING AND PASTING TEXT
1157 1264
1158The behaviour of text selection and insertion mechanism is similar to 1265The behaviour of text selection and insertion/pasting mechanism is similar
1159I<xterm>(1). 1266to I<xterm>(1).
1160 1267
1161=over 4 1268=over 4
1162 1269
1163=item B<Selection>: 1270=item B<Selecting>:
1164 1271
1165Left click at the beginning of the region, drag to the end of the region 1272Left click at the beginning of the region, drag to the end of the region
1166and release; Right click to extend the marked region; Left double-click 1273and release; Right click to extend the marked region; Left double-click
1167to select a word; Left triple-click to select the entire logical line 1274to select a word; Left triple-click to select the entire logical line
1168(which can span multiple screen lines), unless modified by resource 1275(which can span multiple screen lines), unless modified by resource
1172(Compile: I<frills>) will create a rectangular selection instead of a 1279(Compile: I<frills>) will create a rectangular selection instead of a
1173normal one. In this mode, every selected row becomes its own line in the 1280normal one. In this mode, every selected row becomes its own line in the
1174selection, and trailing whitespace is visually underlined and removed from 1281selection, and trailing whitespace is visually underlined and removed from
1175the selection. 1282the selection.
1176 1283
1177=item B<Insertion>: 1284=item B<Pasting>:
1178 1285
1179Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1286Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1180an B<@@RXVT_NAME@@> window causes the current text selection to be 1287window causes the value of the PRIMARY selection (or CLIPBOARD with the
1181inserted as if it had been typed on the keyboard. 1288B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1289
1290Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1291inserted too.
1182 1292
1183=back 1293=back
1184 1294
1185=head1 CHANGING FONTS 1295=head1 CHANGING FONTS
1186 1296
1187Changing fonts (or font sizes, respectively) via the keypad is not yet 1297Changing fonts (or font sizes, respectively) via the keypad is not yet
1188supported in rxvt-unicode. Bug me if you need this. 1298supported in rxvt-unicode. Bug me if you need this.
1189 1299
1190You can, however, switch fonts at runtime using escape sequences (and 1300You can, however, switch fonts at runtime using escape sequences, e.g.:
1191therefore using the menubar), e.g.:
1192 1301
1193 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1302 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1303
1304You can use keyboard shortcuts, too:
1305
1306 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1307 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1194 1308
1195rxvt-unicode will automatically re-apply these fonts to the output so far. 1309rxvt-unicode will automatically re-apply these fonts to the output so far.
1196 1310
1197=head1 ISO 14755 SUPPORT 1311=head1 ISO 14755 SUPPORT
1198 1312
1199ISO 14755 is a standard for entering and viewing unicode characters 1313ISO 14755 is a standard for entering and viewing unicode characters
1200and character codes using the keyboard. It consists of 4 parts. The 1314and character codes using the keyboard. It consists of 4 parts. The
1201first part is available rxvt-unicode has been compiled with 1315first part is available if rxvt-unicode has been compiled with
1202C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1316C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1203with C<--enable-iso14755>. 1317with C<--enable-iso14755>.
1204 1318
1205=over 4 1319=over 4
1206 1320
1226This mode lets you input characters representing the keycap symbols of 1340This mode lets you input characters representing the keycap symbols of
1227your keyboard, if representable in the current locale encoding. 1341your keyboard, if representable in the current locale encoding.
1228 1342
1229Start by pressing C<Control> and C<Shift> together, then releasing 1343Start by pressing C<Control> and C<Shift> together, then releasing
1230them. The next special key (cursor keys, home etc.) you enter will not 1344them. The next special key (cursor keys, home etc.) you enter will not
1231invoke it's usual function but instead will insert the corresponding 1345invoke its usual function but instead will insert the corresponding
1232keycap symbol. The symbol will only be entered when the key has been 1346keycap symbol. The symbol will only be entered when the key has been
1233released, otherwise pressing e.g. C<Shift> would enter the symbol for 1347released, otherwise pressing e.g. C<Shift> would enter the symbol for
1234C<ISO Level 2 Switch>, although your intention might have been to enter a 1348C<ISO Level 2 Switch>, although your intention might have been to enter a
1235reverse tab (Shift-Tab). 1349reverse tab (Shift-Tab).
1236 1350
1269=head1 COLORS AND GRAPHICS 1383=head1 COLORS AND GRAPHICS
1270 1384
1271In addition to the default foreground and background colours, 1385In addition to the default foreground and background colours,
1272B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1386B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1273high-intensity bold/blink versions of the same). Here is a list of the 1387high-intensity bold/blink versions of the same). Here is a list of the
1274colours with their B<rgb.txt> names. 1388colours with their names.
1275 1389
1276=begin table 1390=begin table
1277 1391
1278 B<color0> (black) = Black 1392 B<color0> (black) = Black
1279 B<color1> (red) = Red3 1393 B<color1> (red) = Red3
1299It is also possible to specify the colour values of B<foreground>, 1413It is also possible to specify the colour values of B<foreground>,
1300B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1414B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1301a number 0-15, as a convenient shorthand to reference the colour name of 1415a number 0-15, as a convenient shorthand to reference the colour name of
1302color0-color15. 1416color0-color15.
1303 1417
1418In addition to the colours defined above, @@RXVT_NAME@@ offers an
1419additional 72 colours. The first 64 of those (with indices 16 to 79)
1420consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
142116>), followed by 8 additional shades of gray (with indices 80 to 87).
1422
1423Together, all those colours implement the 88 colour xterm colours. Only
1424the first 16 can be changed using resources currently, the rest can only
1425be changed via command sequences ("escape codes").
1426
1304Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1427Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1305always swapping the foreground/background colours. This is in contrast to 1428always swapping the foreground/background colours. This is in contrast to
1306I<xterm>(1) where the colours are only swapped if they have not otherwise 1429I<xterm>(1) where the colours are only swapped if they have not otherwise
1307been specified. For example, 1430been specified. For example,
1308 1431
1313would yield White on Black, while on I<xterm>(1) it would yield Black 1436would yield White on Black, while on I<xterm>(1) it would yield Black
1314on White. 1437on White.
1315 1438
1316=back 1439=back
1317 1440
1441=head2 ALPHA CHANNEL SUPPORT
1442
1443If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1444their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1445(recommended, but B<MUST> have 4 digits/component) colour specifications,
1446in addition to the ones provided by X, where the additional A component
1447specifies opacity (alpha) values. The minimum value of C<0> is completely
1448transparent). You can also prefix any color with C<[percent]>, where
1449C<percent> is a decimal percentage (0-100) that specifies the opacity of
1450the color, where C<0> is completely transparent and C<100> is completelxy
1451opaque.
1452
1453You probably need to specify B<"-depth 32">, too, and have the luck that
1454your X-server uses ARGB pixel layout, as X is far from just supporting
1455ARGB visuals out of the box, and rxvt-unicode just fudges around.
1456
1457For example, the following selects an almost completely transparent red
1458background, and an almost opaque pink foreground:
1459
1460 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1461
1462I<Please note that transparency of any kind if completely unsupported by
1463the author. Don't bug him with installation questions!>
1464
1318=head1 ENVIRONMENT 1465=head1 ENVIRONMENT
1319 1466
1320B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1467B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1321 1468
1322=over 4 1469=over 4
1323 1470
1324=item B<TERM> 1471=item B<TERM>
1325 1472
1326Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1473Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1327resources or on the commandline. 1474resources or on the command line.
1328 1475
1329=item B<COLORTERM> 1476=item B<COLORTERM>
1330 1477
1331Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1478Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1332compiled with XPM support, and optionally with the added extension 1479compiled with background image support, and optionally with the added
1333C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1480extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1481screen.
1334 1482
1335=item B<COLORFGBG> 1483=item B<COLORFGBG>
1336 1484
1337Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1485Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1338the colour code used as default foreground/text colour (or the string 1486the colour code used as default foreground/text colour (or the string
1339C<default> to indicate that the default-colour escape sequence is to be 1487C<default> to indicate that the default-colour escape sequence is to be
1340used), C<bg> is the colour code used as default background colour (or the 1488used), C<bg> is the colour code used as default background colour (or the
1341string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1489string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1342was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1490was compiled with background image support. Libraries like C<ncurses>
1343(and do) use this information to optimize screen output. 1491and C<slang> can (and do) use this information to optimize screen output.
1344 1492
1345=item B<WINDOWID> 1493=item B<WINDOWID>
1346 1494
1347Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1495Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1348window, which usually has subwindows for the scrollbar, the terminal 1496window, which usually has subwindows for the scrollbar, the terminal
1354C<--with-terminfo=PATH>. 1502C<--with-terminfo=PATH>.
1355 1503
1356=item B<DISPLAY> 1504=item B<DISPLAY>
1357 1505
1358Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1506Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1359display in it's child processes. 1507display in its child processes.
1360 1508
1361=item B<SHELL> 1509=item B<SHELL>
1362 1510
1363The shell to be used for command execution, defaults to C</bin/sh>. 1511The shell to be used for command execution, defaults to C</bin/sh>.
1364
1365=item B<RXVTPATH>
1366
1367The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1368files.
1369
1370=item B<PATH>
1371
1372Used in the same way as C<RXVTPATH>.
1373 1512
1374=item B<RXVT_SOCKET> 1513=item B<RXVT_SOCKET>
1375 1514
1376The unix domain socket path used by @@RXVT_NAME@@c(1) and 1515The unix domain socket path used by @@RXVT_NAME@@c(1) and
1377@@RXVT_NAME@@d(1). 1516@@RXVT_NAME@@d(1).
1415 1554
1416=item Project Coordinator 1555=item Project Coordinator
1417 1556
1418Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1557Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1419 1558
1420L<http://software.schmorp.de/#rxvt-unicode> 1559L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1421 1560
1422=back 1561=back
1423 1562
1424=head1 AUTHORS 1563=head1 AUTHORS
1425 1564
1447 1586
1448Project Coordinator (changes.txt 2.21a to 2.4.5) 1587Project Coordinator (changes.txt 2.21a to 2.4.5)
1449 1588
1450=item Geoff Wing L<< <gcw@pobox.com> >> 1589=item Geoff Wing L<< <gcw@pobox.com> >>
1451 1590
1452Rewrote screen display and text selection routines. Project Coordinator 1591Rewrote screen display and text selection routines.
1592
1453(changes.txt 2.4.6 - rxvt-unicode) 1593Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1454 1594
1455=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1595=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1456 1596
1457Forked rxvt-unicode, rewrote most of the display code and internal 1597Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1458character handling to store text in unicode, improve xterm 1598extension, random hacks, numerous bugfixes and extensions.
1459compatibility and apply numerous other bugfixes and extensions.
1460 1599
1461Project Coordinator (Changes 1.0 -) 1600Project Coordinator (Changes 1.0 -)
1462 1601
1602=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1603
1604Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1605
1463=back 1606=back
1464 1607

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines