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.86 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.139 by ayin, Wed Oct 17 13:53:42 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
466 my $slave = $pty->slave; 505 my $slave = $pty->slave;
467 while (<$slave>) { print $slave "got <$_>\n" } 506 while (<$slave>) { print $slave "got <$_>\n" }
468 507
469=item B<-pe> I<string> 508=item B<-pe> I<string>
470 509
471Colon-separated list of perl extension scripts to use in this terminal 510Comma-separated list of perl extension scripts to use (or not to use) in
472instance. See resource B<perl-ext>. 511this terminal instance. See resource B<perl-ext> for details.
473 512
474=back 513=back
475 514
476=head1 RESOURCES (available also as long-options) 515=head1 RESOURCES (available also as long-options)
477 516
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 517Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 518options) compiled into your version.
480 519
481There are two different methods that @@RXVT_NAME@@ can use to get the 520You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 521distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 523with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 524
490 1. system-wide app-defaults file, either locale-dependent OR global 525 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 526 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
495 530
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 531Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 532names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 533common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 534configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 535B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 536configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 537be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 538settings. The following resources are supported (you might want to
509resources are allowed: 539check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
540extensions not documented here):
510 541
511=over 4 542=over 4
543
544=item B<depth:> I<bitdepth>
545
546Compile I<xft>: Attempt to find a visual with the given bit depth;
547option B<-depth>.
512 548
513=item B<geometry:> I<geom> 549=item B<geometry:> I<geom>
514 550
515Create the window with the specified X window geometry [default 80x24]; 551Create the window with the specified X window geometry [default 80x24];
516option B<-geometry>. 552option B<-geometry>.
553Use the specified colour to display underlined characters when the 589Use the specified colour to display underlined characters when the
554foreground colour is the default. 590foreground colour is the default.
555 591
556=item B<colorRV:> I<colour> 592=item B<colorRV:> I<colour>
557 593
558Use the specified colour as the background for reverse video 594Use the specified colour as the background for reverse video characters
559characters. 595when OPTION_HC is disabled (--disable-frills).
560 596
561=item B<underlineColor:> I<colour> 597=item B<underlineColor:> I<colour>
562 598
563If set, use the specified colour as the colour for the underline 599If set, use the specified colour as the colour for the underline
564itself. If unset, use the foreground colour. 600itself. If unset, use the foreground colour.
580option B<-rv>. B<False>: regular screen colours [default]; option 616option B<-rv>. B<False>: regular screen colours [default]; option
581B<+rv>. See note in B<COLORS AND GRAPHICS> section. 617B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582 618
583=item B<jumpScroll:> I<boolean> 619=item B<jumpScroll:> I<boolean>
584 620
585B<True>: specify that jump scrolling should be used. When scrolling 621B<True>: specify that jump scrolling should be used. When receiving lots
586quickly, 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
587B<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>.
588 640
589=item B<inheritPixmap:> I<boolean> 641=item B<inheritPixmap:> I<boolean>
590 642
591B<True>: make the background inherit the parent windows' pixmap, giving 643B<True>: make the background inherit the parent windows' pixmap, giving
592artificial transparency. B<False>: do not inherit the parent windows' 644artificial transparency. B<False>: do not inherit the parent windows'
593pixmap. 645pixmap.
594 646
647I<Please note that transparency of any kind if completely unsupported by
648the author. Don't bug him with installation questions!>
649
595=item B<fading:> I<number> 650=item B<fading:> I<number>
596 651
597Fade 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>.
598 653
599=item B<fadeColor:> I<colour> 654=item B<fadeColor:> I<colour>
606Tint the transparent background pixmap with the given colour; option 661Tint the transparent background pixmap with the given colour; option
607B<-tint>. 662B<-tint>.
608 663
609=item B<shading:> I<number> 664=item B<shading:> I<number>
610 665
611Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 666Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612image 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>.
613 677
614=item B<scrollColor:> I<colour> 678=item B<scrollColor:> I<colour>
615 679
616Use the specified colour for the scrollbar [default #B2B2B2]. 680Use the specified colour for the scrollbar [default #B2B2B2].
617 681
625The 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
626and the text. 690and the text.
627 691
628=item B<backgroundPixmap:> I<file[;geom]> 692=item B<backgroundPixmap:> I<file[;geom]>
629 693
630Use the specified XPM file (note the `.xpm' extension is optional) for 694Use the specified image file for the background and also optionally
631the background and also optionally specify its scaling with a geometry 695specify its scaling with a geometry string B<WxH+X+Y>,
632string B<WxH+X+Y>, in which B<"W" / "H"> specify the 696in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
633horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 697and B<"X" / "Y"> locate the image centre (percent).
634centre (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
635of 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
636specifies an integer number of images in that direction. No image will 700number of images in that direction. No image will be magnified beyond
637be magnified beyond 10 times its original size. The maximum permitted 70110 times its original size. The maximum permitted scale is 1000.
638scale is 1000. [default 0x0+50+50] 702Special string of B<"auto"> used as a geometry will cause image to be
639 703automatically scaled to match window size.
640=item B<menu:> I<file[;tag]> 704If used in conjunction with B<-tr> option - specified pixmap will be
641 705blended over transparency image using either alpha-blending, or any
642Read in the specified menu file (note the `.menu' extension is 706other blending type, specified with B<-blt "type"> option.
643optional) and also optionally specify a starting tag to find. See the 707[default 0x0+50+50]
644reference documentation for details on the syntax for the menuBar.
645 708
646=item B<path:> I<path> 709=item B<path:> I<path>
647 710
648Specify the colon-delimited search path for finding files (XPM and 711Specify the colon-delimited search path for finding background image files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 712
652=item B<font:> I<fontlist> 713=item B<font:> I<fontlist>
653 714
654Select 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
655names that are used in turn when trying to display Unicode characters. 716that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 717first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 718smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 719font list is always appended to it; option B<-fn>.
659 720
660Each 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
661optional 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:>.
662 723
663In addition, each font can be prefixed with additional hints and 724In addition, each font can be prefixed with additional hints and
665hint 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
666fonts. 727fonts.
667 728
668For example, this font resource 729For example, this font resource
669 730
670 URxvt*font: 9x15bold,\ 731 URxvt.font: 9x15bold,\
671 -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,\
672 -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, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 734 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 735 xft:Code2000:antialias=false
675 736
713 774
714=item B<intensityStyles:> I<boolean> 775=item B<intensityStyles:> I<boolean>
715 776
716When 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>,
717option B<-is>, the default), bold and italic font styles imply high 778option B<-is>, the default), bold and italic font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>, 779intensity foreground/background colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not 780option B<+is>) disables this behaviour, the high intensity colours are not
720reachable. 781reachable.
721 782
722=item B<selectstyle:> I<mode> 783=item B<selectstyle:> I<mode>
723 784
724Set 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
725xterm 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
726xterm style selection. 787gives xterm style selection. Only effective when the original (non-perl)
788selection code is in use.
727 789
728=item B<scrollstyle:> I<mode> 790=item B<scrollstyle:> I<mode>
729 791
730Set 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
731the author's favourite. 793the author's favourite.
745=item B<mapAlert:> I<boolean> 807=item B<mapAlert:> I<boolean>
746 808
747B<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
748de-iconify (map) on receipt of a bell character [default]. 810de-iconify (map) on receipt of a bell character [default].
749 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
750=item B<visualBell:> I<boolean> 817=item B<visualBell:> I<boolean>
751 818
752B<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>.
753B<False>: no visual bell [default]; option B<+vb>. 820B<False>: no visual bell [default]; option B<+vb>.
754 821
772 839
773The 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.
774 841
775Example: 842Example:
776 843
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 844 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 845
779This 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
780everytime you hit C<Print>. 847every time you hit C<Print>.
781 848
782=item B<scrollBar:> I<boolean> 849=item B<scrollBar:> I<boolean>
783 850
784B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 851B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785disable the scrollbar; option B<+sb>. 852disable the scrollbar; option B<+sb>.
807 874
808=item B<scrollWithBuffer:> I<boolean> 875=item B<scrollWithBuffer:> I<boolean>
809 876
810B<True>: scroll with scrollback buffer when tty receives new lines (and 877B<True>: scroll with scrollback buffer when tty receives new lines (and
811B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 878B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812with scrollback buffer when tty recieves new lines; option B<+sw>. 879with scrollback buffer when tty receives new lines; option B<+sw>.
813 880
814=item B<scrollTtyKeypress:> I<boolean> 881=item B<scrollTtyKeypress:> I<boolean>
815 882
816B<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
817are those which are intercepted by rxvt-unicode for special handling and 884are those which are intercepted by rxvt-unicode for special handling and
848=item B<termName:> I<termname> 915=item B<termName:> I<termname>
849 916
850Specifies 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
851variable; option B<-tn>. 918variable; option B<-tn>.
852 919
853=item B<linespace:> I<number> 920=item B<lineSpace:> I<number>
854 921
855Specifies number of lines (pixel height) to insert between each row of 922Specifies number of lines (pixel height) to insert between each row of
856the display [default 0]; option B<-lsp>. 923the display [default 0]; option B<-lsp>.
857 924
858=item B<meta8:> I<boolean> 925=item B<meta8:> I<boolean>
907pressed. If unset it will send the sequence traditionally associated 974pressed. If unset it will send the sequence traditionally associated
908with the B<Execute> key. 975with the B<Execute> key.
909 976
910=item B<cutchars:> I<string> 977=item B<cutchars:> I<string>
911 978
912The characters used as delimiters for double-click word selection. The 979The characters used as delimiters for double-click word selection
913built-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:
914 989
915B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 990B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
916 991
917=item B<preeditType:> I<style> 992=item B<preeditType:> I<style>
918 993
954default. (Note that many other terminals, including xterm, have these 1029default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 1030sequences enabled by default, which doesn't make it safer, though).
956 1031
957You can enable them by setting this boolean resource or specifying 1032You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 1033B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 1034locale, findfont, icon label and window title requests.
960menubar dispatch.
961 1035
962=item B<modifier:> I<modifier> 1036=item B<modifier:> I<modifier>
963 1037
964Set 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>,
965B<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
969 1043
970Specify 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)
971character is passed through. It may contain escape values as described 1045character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 1046in the entry on B<keysym> following.
973 1047
974=item B<secondaryScreen:> I<bool> 1048=item B<secondaryScreen:> I<boolean>
975 1049
976Turn on/off secondary screen (default enabled). 1050Turn on/off secondary screen (default enabled).
977 1051
978=item B<secondaryScroll:> I<bool> 1052=item B<secondaryScroll:> I<boolean>
979 1053
980Turn on/off secondary screen scroll (default enabled). If the this 1054Turn on/off secondary screen scroll (default enabled). If this
981option is enabled, scrolls on the secondary screen will change the 1055option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 1056scrollback buffer and switching to/from the secondary screen will
983instead scroll the screen up. 1057instead scroll the screen up.
984 1058
985=item B<hold>: I<bool> 1059=item B<hold>: I<boolean>
986 1060
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1061Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 1062will not immediately destroy its window when the program executed within
989it 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
990user. 1064user.
1009searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1083searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1010omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1084omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1011keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1085keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1012performed in an exact manner; however, the closest match is assured. 1086performed in an exact manner; however, the closest match is assured.
1013 1087
1014I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1088I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1089number), see RESOURCES in C<man 7 X> for futher details.
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace.
1019
1020Please note that you need to double the C<\> when using
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023@@RXVT_NAME@@'s own processing).
1024 1090
1025You can define a range of keysyms in one shot by providing a I<string> 1091You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1092with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027should be a character not used by the strings. 1093should be a character not used by the strings.
1028 1094
1029Its usage can be demonstrated by an example: 1095Its usage can be demonstrated by an example:
1030 1096
1031 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1084 1150
1085=item B<perl-ext-common>: I<string> 1151=item B<perl-ext-common>: I<string>
1086 1152
1087=item B<perl-ext>: I<string> 1153=item B<perl-ext>: I<string>
1088 1154
1089Colon-separated list(s) of perl extension scripts to use in this terminal 1155Comma-separated list(s) of perl extension scripts (default: C<default>) to
1156use in this terminal instance; option B<-pe>.
1157
1158Extension names can be prefixed with a C<-> sign to prohibit using
1159them. This can be useful to selectively disable some extensions loaded
1160by default, or specified via the C<perl-ext-common> resource. For
1161example, C<default,-selection> will use all the default extension except
1162C<selection>.
1163
1164Extension names can also be followed by an argument in angle brackets
1165(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1166searchable scrollback to Alt/Meta-s). Mentioning the same extension
1167multiple times with different arguments will pass multiple arguments to
1168the extension.
1169
1090instance. Each extension is looked up in the library directories, loaded 1170Each extension is looked up in the library directories, loaded if
1091if necessary, and bound to the current terminal instance. If this 1171necessary, and bound to the current terminal instance.
1092resource is empty or missing, then the perl interpreter will not be 1172
1093initialized. The idea behind two options is that B<perl-ext-common> will 1173If both of these resources are the empty string, then the perl
1094be used for extensions that should be available to all instances, while 1174interpreter will not be initialized. The idea behind two options is that
1095B<perl-ext> is used for specific instances; option B<-pe>. 1175B<perl-ext-common> will be used for extensions that should be available to
1176all instances, while B<perl-ext> is used for specific instances.
1096 1177
1097=item B<perl-eval>: I<string> 1178=item B<perl-eval>: I<string>
1098 1179
1099Perl code to be evaluated when all extensions have been registered. See the 1180Perl code to be evaluated when all extensions have been registered. See
1100@@RXVT_NAME@@perl(3) manpage. 1181the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1182will be ignored when running setuid/setgid.
1101 1183
1102=item B<perl-lib>: I<path> 1184=item B<perl-lib>: I<path>
1103 1185
1104Colon-separated list of additional directories that hold extension 1186Colon-separated list of additional directories that hold extension
1105scripts. When looking for extensions specified by the C<perl> resource, 1187scripts. When looking for extensions specified by the C<perl> resource,
1106@@RXVT_NAME@@ will first look in these directories and then in 1188@@RXVT_NAME@@ will first look in these directories and then in
1107F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1189F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1190will be ignored when running setuid/setgid.
1108 1191
1109See the @@RXVT_NAME@@perl(3) manpage. 1192See the @@RXVT_NAME@@perl(3) manpage.
1193
1194=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1195
1196Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1197details.
1198
1199=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1200
1201Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1202for details.
1203
1204=item B<searchable-scrollback:> I<keysym>
1205
1206Sets the hotkey that starts the incremental scrollback buffer search
1207(default: C<M-s>).
1208
1209=item B<urlLauncher>: I<string>
1210
1211Specifies the program to be started with a URL argument. Used by the
1212C<selection-popup> and C<matcher> perl extensions.
1213
1214=item B<transient-for>: I<windowid>
1215
1216Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1217
1218=item B<override-redirect>: I<boolean>
1219
1220Compile I<frills>: Sets override-redirect for the terminal window, making
1221it almost invisible to window managers; option B<-override-redirect>.
1222
1223=item B<iso14755_52:> I<boolean>
1224
1225Turn on/off ISO 14755 5.2 mode (default enabled).
1110 1226
1111=back 1227=back
1112 1228
1113=head1 THE SCROLLBAR 1229=head1 THE SCROLLBAR
1114 1230
1133application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1249application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1134(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1250(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1135up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1251up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1136respectively. 1252respectively.
1137 1253
1138=head1 TEXT SELECTION AND INSERTION 1254=head1 THE SELECTION: SELECTING AND PASTING TEXT
1139 1255
1140The behaviour of text selection and insertion mechanism is similar to 1256The behaviour of text selection and insertion/pasting mechanism is similar
1141I<xterm>(1). 1257to I<xterm>(1).
1142 1258
1143=over 4 1259=over 4
1144 1260
1145=item B<Selection>: 1261=item B<Selecting>:
1146 1262
1147Left click at the beginning of the region, drag to the end of the region 1263Left click at the beginning of the region, drag to the end of the region
1148and release; Right click to extend the marked region; Left double-click 1264and release; Right click to extend the marked region; Left double-click
1149to select a word; Left triple-click to select the entire logical line 1265to select a word; Left triple-click to select the entire logical line
1150(which can span multiple screen lines), unless modified by resource 1266(which can span multiple screen lines), unless modified by resource
1154(Compile: I<frills>) will create a rectangular selection instead of a 1270(Compile: I<frills>) will create a rectangular selection instead of a
1155normal one. In this mode, every selected row becomes its own line in the 1271normal one. In this mode, every selected row becomes its own line in the
1156selection, and trailing whitespace is visually underlined and removed from 1272selection, and trailing whitespace is visually underlined and removed from
1157the selection. 1273the selection.
1158 1274
1159=item B<Insertion>: 1275=item B<Pasting>:
1160 1276
1161Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1277Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1162an B<@@RXVT_NAME@@> window causes the current text selection to be 1278window causes the value of the PRIMARY selection (or CLIPBOARD with the
1163inserted as if it had been typed on the keyboard. 1279B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1280
1281Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1282inserted too.
1164 1283
1165=back 1284=back
1166 1285
1167=head1 CHANGING FONTS 1286=head1 CHANGING FONTS
1168 1287
1169Changing fonts (or font sizes, respectively) via the keypad is not yet 1288Changing fonts (or font sizes, respectively) via the keypad is not yet
1170supported in rxvt-unicode. Bug me if you need this. 1289supported in rxvt-unicode. Bug me if you need this.
1171 1290
1172You can, however, switch fonts at runtime using escape sequences (and 1291You can, however, switch fonts at runtime using escape sequences, e.g.:
1173therefore using the menubar), e.g.:
1174 1292
1175 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1293 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1294
1295You can use keyboard shortcuts, too:
1296
1297 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1298 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1176 1299
1177rxvt-unicode will automatically re-apply these fonts to the output so far. 1300rxvt-unicode will automatically re-apply these fonts to the output so far.
1178 1301
1179=head1 ISO 14755 SUPPORT 1302=head1 ISO 14755 SUPPORT
1180 1303
1181ISO 14755 is a standard for entering and viewing unicode characters 1304ISO 14755 is a standard for entering and viewing unicode characters
1182and character codes using the keyboard. It consists of 4 parts. The 1305and character codes using the keyboard. It consists of 4 parts. The
1183first part is available rxvt-unicode has been compiled with 1306first part is available if rxvt-unicode has been compiled with
1184C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1307C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1185with C<--enable-iso14755>. 1308with C<--enable-iso14755>.
1186 1309
1187=over 4 1310=over 4
1188 1311
1208This mode lets you input characters representing the keycap symbols of 1331This mode lets you input characters representing the keycap symbols of
1209your keyboard, if representable in the current locale encoding. 1332your keyboard, if representable in the current locale encoding.
1210 1333
1211Start by pressing C<Control> and C<Shift> together, then releasing 1334Start by pressing C<Control> and C<Shift> together, then releasing
1212them. The next special key (cursor keys, home etc.) you enter will not 1335them. The next special key (cursor keys, home etc.) you enter will not
1213invoke it's usual function but instead will insert the corresponding 1336invoke its usual function but instead will insert the corresponding
1214keycap symbol. The symbol will only be entered when the key has been 1337keycap symbol. The symbol will only be entered when the key has been
1215released, otherwise pressing e.g. C<Shift> would enter the symbol for 1338released, otherwise pressing e.g. C<Shift> would enter the symbol for
1216C<ISO Level 2 Switch>, although your intention might have been to enter a 1339C<ISO Level 2 Switch>, although your intention might have been to enter a
1217reverse tab (Shift-Tab). 1340reverse tab (Shift-Tab).
1218 1341
1251=head1 COLORS AND GRAPHICS 1374=head1 COLORS AND GRAPHICS
1252 1375
1253In addition to the default foreground and background colours, 1376In addition to the default foreground and background colours,
1254B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1377B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1255high-intensity bold/blink versions of the same). Here is a list of the 1378high-intensity bold/blink versions of the same). Here is a list of the
1256colours with their B<rgb.txt> names. 1379colours with their names.
1257 1380
1258=begin table 1381=begin table
1259 1382
1260 B<color0> (black) = Black 1383 B<color0> (black) = Black
1261 B<color1> (red) = Red3 1384 B<color1> (red) = Red3
1281It is also possible to specify the colour values of B<foreground>, 1404It is also possible to specify the colour values of B<foreground>,
1282B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1405B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1283a number 0-15, as a convenient shorthand to reference the colour name of 1406a number 0-15, as a convenient shorthand to reference the colour name of
1284color0-color15. 1407color0-color15.
1285 1408
1409In addition to the colours defined above, @@RXVT_NAME@@ offers an
1410additional 72 colours. The first 64 of those (with indices 16 to 79)
1411consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141216>), followed by 8 additional shades of gray (with indices 80 to 87).
1413
1414Together, all those colours implement the 88 colour xterm colours. Only
1415the first 16 can be changed using resources currently, the rest can only
1416be changed via command sequences ("escape codes").
1417
1286Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1418Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1287always swapping the foreground/background colours. This is in contrast to 1419always swapping the foreground/background colours. This is in contrast to
1288I<xterm>(1) where the colours are only swapped if they have not otherwise 1420I<xterm>(1) where the colours are only swapped if they have not otherwise
1289been specified. For example, 1421been specified. For example,
1290 1422
1295would yield White on Black, while on I<xterm>(1) it would yield Black 1427would yield White on Black, while on I<xterm>(1) it would yield Black
1296on White. 1428on White.
1297 1429
1298=back 1430=back
1299 1431
1432=head2 ALPHA CHANNEL SUPPORT
1433
1434If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1435their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1436(recommended, but B<MUST> have 4 digits/component) colour specifications,
1437in addition to the ones provided by X, where the additional A component
1438specifies opacity (alpha) values. The minimum value of C<0> is completely
1439transparent). You can also prefix any color with C<[percent]>, where
1440C<percent> is a decimal percentage (0-100) that specifies the opacity of
1441the color, where C<0> is completely transparent and C<100> is completelxy
1442opaque.
1443
1444You probably need to specify B<"-depth 32">, too, and have the luck that
1445your X-server uses ARGB pixel layout, as X is far from just supporting
1446ARGB visuals out of the box, and rxvt-unicode just fudges around.
1447
1448For example, the following selects an almost completely transparent red
1449background, and an almost opaque pink foreground:
1450
1451 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1452
1453I<Please note that transparency of any kind if completely unsupported by
1454the author. Don't bug him with installation questions!>
1455
1300=head1 ENVIRONMENT 1456=head1 ENVIRONMENT
1301 1457
1302B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1458B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1303 1459
1304=over 4 1460=over 4
1305 1461
1306=item B<TERM> 1462=item B<TERM>
1307 1463
1308Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1464Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1309resources or on the commandline. 1465resources or on the command line.
1310 1466
1311=item B<COLORTERM> 1467=item B<COLORTERM>
1312 1468
1313Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1469Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1314compiled with XPM support, and optionally with the added extension 1470compiled with background image support, and optionally with the added
1315C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1471extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472screen.
1316 1473
1317=item B<COLORFGBG> 1474=item B<COLORFGBG>
1318 1475
1319Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1476Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1320the colour code used as default foreground/text colour (or the string 1477the colour code used as default foreground/text colour (or the string
1321C<default> to indicate that the default-colour escape sequence is to be 1478C<default> to indicate that the default-colour escape sequence is to be
1322used), C<bg> is the colour code used as default background colour (or the 1479used), C<bg> is the colour code used as default background colour (or the
1323string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1480string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1324was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1481was compiled with background image support. Libraries like C<ncurses>
1325(and do) use this information to optimize screen output. 1482and C<slang> can (and do) use this information to optimize screen output.
1326 1483
1327=item B<WINDOWID> 1484=item B<WINDOWID>
1328 1485
1329Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1486Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1330window, which usually has subwindows for the scrollbar, the terminal 1487window, which usually has subwindows for the scrollbar, the terminal
1336C<--with-terminfo=PATH>. 1493C<--with-terminfo=PATH>.
1337 1494
1338=item B<DISPLAY> 1495=item B<DISPLAY>
1339 1496
1340Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1497Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1341display in it's child processes. 1498display in its child processes.
1342 1499
1343=item B<SHELL> 1500=item B<SHELL>
1344 1501
1345The shell to be used for command execution, defaults to C</bin/sh>. 1502The shell to be used for command execution, defaults to C</bin/sh>.
1346
1347=item B<RXVTPATH>
1348
1349The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1350files.
1351
1352=item B<PATH>
1353
1354Used in the same way as C<RXVTPATH>.
1355 1503
1356=item B<RXVT_SOCKET> 1504=item B<RXVT_SOCKET>
1357 1505
1358The unix domain socket path used by @@RXVT_NAME@@c(1) and 1506The unix domain socket path used by @@RXVT_NAME@@c(1) and
1359@@RXVT_NAME@@d(1). 1507@@RXVT_NAME@@d(1).
1397 1545
1398=item Project Coordinator 1546=item Project Coordinator
1399 1547
1400Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1548Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1401 1549
1402L<http://software.schmorp.de/#rxvt-unicode> 1550L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1403 1551
1404=back 1552=back
1405 1553
1406=head1 AUTHORS 1554=head1 AUTHORS
1407 1555
1429 1577
1430Project Coordinator (changes.txt 2.21a to 2.4.5) 1578Project Coordinator (changes.txt 2.21a to 2.4.5)
1431 1579
1432=item Geoff Wing L<< <gcw@pobox.com> >> 1580=item Geoff Wing L<< <gcw@pobox.com> >>
1433 1581
1434Rewrote screen display and text selection routines. Project Coordinator 1582Rewrote screen display and text selection routines.
1583
1435(changes.txt 2.4.6 - rxvt-unicode) 1584Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1436 1585
1437=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1586=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1438 1587
1439Forked rxvt-unicode, rewrote most of the display code and internal 1588Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1440character handling to store text in unicode, improve xterm 1589extension, random hacks, numerous bugfixes and extensions.
1441compatibility and apply numerous other bugfixes and extensions.
1442 1590
1443Project Coordinator (Changes 1.0 -) 1591Project Coordinator (Changes 1.0 -)
1444 1592
1593=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1594
1595Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1596
1445=back 1597=back
1446 1598

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines