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.152 by root, Wed Dec 12 19:56:37 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://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
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 in 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>.
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background; resource B<transparent>.
122
123B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 128
115=item B<-fade> I<number> 129=item B<-fade> I<number>
116 130
117Fade the text by the given percentage when focus is lost. Small values 131Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 132fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 133colour; resource B<fading>.
120 134
121=item B<-fadecolor> I<colour> 135=item B<-fadecolor> I<colour>
122 136
123Fade to this colour when fading is used (see B<-fade>). The default colour 137Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 138is opaque black. resource B<fadeColor>.
125 139
126=item B<-tint> I<colour> 140=item B<-tint> I<colour>
127 141
128Tint the transparent background pixmap with the given colour when 142Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 143transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 144non-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 145used to brighten or darken the image in addition to tinting it.
146Please note that certain tint colours can be applied on the server-side,
147thus yielding performance gain of two orders of magnitude. These colours are:
148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 150I<tintColor>. Example:
133 151
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 152 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 153
136=item B<-sh> 154=item B<-sh> I<number>
137 155
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 156Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 157background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 158resource I<shading>.
159
160=item B<-blt> I<string>
161
162Specify background blending type. If background pixmap is specified
163at the same time as transparency - such pixmap will be blended over
164transparency image, using method specified. Supported values are :
165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168alpha-blending. Compile I<afterimage>; resource I<blendType>.
169
170=item B<-blr> I<HxV>
171
172Apply Gaussian Blur with the specified radii to the transparent
173background image. If single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177resource I<blurRadius>.
141 178
142=item B<-bg> I<colour> 179=item B<-bg> I<colour>
143 180
144Window background colour; resource B<background>. 181Window background colour; resource B<background>.
145 182
146=item B<-fg> I<colour> 183=item B<-fg> I<colour>
147 184
148Window foreground colour; resource B<foreground>. 185Window foreground colour; resource B<foreground>.
149 186
150=item B<-pixmap> I<file[;geom]> 187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 188
152Compile I<XPM>: Specify XPM file for the background and also optionally 189Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 190optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 191add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 192command-line; for more details see resource B<backgroundPixmap>.
156 193
157=item B<-cr> I<colour> 194=item B<-cr> I<colour>
158 195
159The cursor colour; resource B<cursorColor>. 196The cursor colour; resource B<cursorColor>.
160 197
172resource B<borderColor>. 209resource B<borderColor>.
173 210
174=item B<-fn> I<fontlist> 211=item B<-fn> I<fontlist>
175 212
176Select the fonts to be used. This is a comma separated list of font names 213Select 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 214that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 215first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 216smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 217font list is always appended to it. See resource B<font> for more details.
181 218
182In short, to specify an X11 core font, just specify it's name or prefix it 219In 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:>, 220with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 221e.g.:
185 222
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 223 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 224 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
297 334
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 335Compile 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 336if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 337decorations; resource B<borderLess>.
301 338
339=item B<-override-redirect>
340
341Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>.
343
302=item B<-sbg> 344=item B<-sbg>
303 345
304Compile I<frills>: Disable the usage of the built-in block graphics/line 346Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 347drawing 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; 348this if you have a good font and want to use its block graphic glyphs;
308 350
309=item B<-lsp> I<number> 351=item B<-lsp> I<number>
310 352
311Compile I<frills>: Lines (pixel height) to insert between each row of 353Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 354the display. Useful to work around font rendering problems; resource
313B<linespace>. 355B<lineSpace>.
314 356
315=item B<-tn> I<termname> 357=item B<-tn> I<termname>
316 358
317This option specifies the name of the terminal type to be set in the 359This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 360B<TERM> environment variable. This terminal type must exist in the
372for more info. 414for more info.
373 415
374=item B<-tcw> 416=item B<-tcw>
375 417
376Change the meaning of triple-click selection with the left mouse 418Change the meaning of triple-click selection with the left mouse
419button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 420in-use. Instead of selecting a full line it will extend the selection to
378end of the logical line only. resource B<tripleclickwords>. 421the end of the logical line only. resource B<tripleclickwords>.
379 422
380=item B<-insecure> 423=item B<-insecure>
381 424
382Enable "insecure" mode, which currently enables most of the escape 425Enable "insecure" mode, which currently enables most of the escape
383sequences that echo strings. See the resource B<insecure> for more 426sequences that echo strings. See the resource B<insecure> for more
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within 448will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the 449it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>. 450user; resource B<hold>.
408 451
452=item B<-xrm> I<string>
453
454Works like the X Toolkit option of the same name, by adding the I<string>
455as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications.
457
458Note that you need to use the I<same> syntax as in the .Xdefaults file,
459e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
460options can be specified as long-options on the commandline, so use
461of B<-xrm> is mostly limited to cases where you want to specify other
462resources (e.g. for input methods) or for compatibility with other
463programs.
464
409=item B<-keysym.>I<sym> I<string> 465=item B<-keysym.>I<sym> I<string>
410 466
411Remap a key symbol. See resource B<keysym>. 467Remap a key symbol. See resource B<keysym>.
412 468
413=item B<-embed> I<windowid> 469=item B<-embed> I<windowid>
414 470
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 471Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 472which enables applications to easily embed a terminal.
417 473
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 474Right 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 475shouldn'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 476quite 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. 479The window will not be destroyed when @@RXVT_NAME@@ exits.
424 480
425It might be useful to know that @@RXVT_NAME@@ will not close file 481It 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 482descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 483can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 484terminal. This works regardless of whether the C<-embed> option was used or
429not. 485not.
430 486
431Here is a short Gtk2-perl snippet that illustrates how this option can be 487Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 488used (a longer example is in F<doc/embed>):
433 489
438 }); 494 });
439 495
440=item B<-pty-fd> I<file descriptor> 496=item B<-pty-fd> I<file descriptor>
441 497
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 498Tells @@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 499pair 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 500useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 501without having to run a program within it.
446 502
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 503If 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 504entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that. 505yourself if you want that.
450 506
451As an extremely special case, specifying C<-1> will completely suppress 507As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations. 508pty/tty operations, which is probably only useful in conjunction with some
509perl extension that manages the terminal.
453 510
454Here is a example in perl that illustrates how this option can be used (a 511Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>): 512longer example is in F<doc/pty-fd>):
456 513
457 use IO::Pty; 514 use IO::Pty;
471Comma-separated list of perl extension scripts to use (or not to use) in 528Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details. 529this terminal instance. See resource B<perl-ext> for details.
473 530
474=back 531=back
475 532
476=head1 RESOURCES (available also as long-options) 533=head1 RESOURCES
477 534
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 535Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 536options) compiled into your version. All resources are also available as
537long-options.
480 538
481You can set and change the resources using X11 tools like B<xrdb>. Many 539You can set and change the resources using X11 tools like B<xrdb>. Many
482distribution do also load settings from the B<~/.Xresources> file when X 540distribution do also load settings from the B<~/.Xresources> file when X
483starts. @@RXVT_NAME@@ will consult the following files/resources in order, 541starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484with later settings overwriting earlier ones: 542with later settings overwriting earlier ones:
486 1. system-wide app-defaults file, either locale-dependent OR global 544 1. system-wide app-defaults file, either locale-dependent OR global
487 2. app-defaults file in $XAPPLRESDIR 545 2. app-defaults file in $XAPPLRESDIR
488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 546 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
489 4. SCREEN_RESOURCES for the current screen 547 4. SCREEN_RESOURCES for the current screen
490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 548 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549 6. resources specified via -xrm on the commandline
491 550
492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 551Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 552names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 553common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495configured, while the class name B<URxvt> allows resources unique to 554configured, while the class name B<URxvt> allows resources unique to
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 559check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 560extensions not documented here):
502 561
503=over 4 562=over 4
504 563
564=item B<depth:> I<bitdepth>
565
566Compile I<xft>: Attempt to find a visual with the given bit depth;
567option B<-depth>.
568
505=item B<geometry:> I<geom> 569=item B<geometry:> I<geom>
506 570
507Create the window with the specified X window geometry [default 80x24]; 571Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 572option B<-geometry>.
509 573
545Use the specified colour to display underlined characters when the 609Use the specified colour to display underlined characters when the
546foreground colour is the default. 610foreground colour is the default.
547 611
548=item B<colorRV:> I<colour> 612=item B<colorRV:> I<colour>
549 613
550Use the specified colour as the background for reverse video 614Use the specified colour as the background for reverse video characters
551characters. 615when OPTION_HC is disabled (--disable-frills).
552 616
553=item B<underlineColor:> I<colour> 617=item B<underlineColor:> I<colour>
554 618
555If set, use the specified colour as the colour for the underline 619If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 620itself. If unset, use the foreground colour.
572option B<-rv>. B<False>: regular screen colours [default]; option 636option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 637B<+rv>. See note in B<COLORS AND GRAPHICS> section.
574 638
575=item B<jumpScroll:> I<boolean> 639=item B<jumpScroll:> I<boolean>
576 640
577B<True>: specify that jump scrolling should be used. When scrolling 641B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, fewer screen updates are performed [default]; option B<-j>. 642of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
643has been read, resulting in fewer updates while still displaying every
644received line; option B<-j>.
645
579B<False>: specify that smooth scrolling should be used; option B<+j>. 646B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
647force a screen refresh on each new line it received; option B<+j>.
580 648
581=item B<inheritPixmap:> I<boolean> 649=item B<skipScroll:> I<boolean>
582 650
583B<True>: make the background inherit the parent windows' pixmap, giving 651B<True>: (the default) specify that skip scrolling should be used. When
584artificial transparency. B<False>: do not inherit the parent windows' 652receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585pixmap. 653(around 60 times per second), resulting in far fewer updates. This can
654result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
655option B<-ss>.
656
657B<False>: specify that everything is to be displayed, even
658if the refresh is too fast for the human eye to read anything (or the
659monitor to display anything); option B<+ss>.
660
661=item B<transparent:> I<boolean>
662
663Turn on/off illusion of a transparent window background.
664
665B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
666future versions.
667
668I<Please address all transparency related issues to Sasha Vasko at
669sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
586 670
587=item B<fading:> I<number> 671=item B<fading:> I<number>
588 672
589Fade the text by the given percentage when focus is lost; option B<-fade>. 673Fade the text by the given percentage when focus is lost; option B<-fade>.
590 674
598Tint the transparent background pixmap with the given colour; option 682Tint the transparent background pixmap with the given colour; option
599B<-tint>. 683B<-tint>.
600 684
601=item B<shading:> I<number> 685=item B<shading:> I<number>
602 686
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 687Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604image in addition to tinting it. 688in addition to tinting it; option B<-sh>.
689
690=item B<blendType:> I<string>
691
692Specify background blending type; option B<-blt>.
693
694=item B<blurRadius:> I<number>
695
696Apply Gaussian Blurr with the specified radius to the transparent
697background image; option B<-blr>.
605 698
606=item B<scrollColor:> I<colour> 699=item B<scrollColor:> I<colour>
607 700
608Use the specified colour for the scrollbar [default #B2B2B2]. 701Use the specified colour for the scrollbar [default #B2B2B2].
609 702
615=item B<borderColor:> I<colour> 708=item B<borderColor:> I<colour>
616 709
617The colour of the border around the text area and between the scrollbar 710The colour of the border around the text area and between the scrollbar
618and the text. 711and the text.
619 712
620=item B<backgroundPixmap:> I<file[;geom]> 713=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
621 714
622Use the specified XPM file (note the `.xpm' extension is optional) for 715Use the specified image file for the background and also
623the background and also optionally specify its scaling with a geometry 716optionally specify its scaling with a geometry string B<WxH+X+Y>,
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 717(default C<0x0+50+50>) in which B<"W" / "H"> specify the
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 718horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
626centre (percent). A scale of 0 displays the image with tiling. A scale 719centre (percent). A scale of 0 displays the image with tiling. A scale
627of 1 displays the image without any scaling. A scale of 2 to 9 720of 1 displays the image without any scaling. A scale of 2 to 9 specifies
628specifies an integer number of images in that direction. No image will 721an integer number of images in that direction. No image will be magnified
629be magnified beyond 10 times its original size. The maximum permitted 722beyond 10 times its original size. The maximum permitted scale is 1000.
630scale is 1000. [default 0x0+50+50] 723Additional operations can be specified after colon B<:op1:op2...>.
724Supported operations are:
631 725
632=item B<menu:> I<file[;tag]> 726 tile force background image to be tiled and not scaled. Equivalent to 0x0,
727 propscale will scale image keeping proportions,
728 auto will scale image to match window size. Equivalent to 100x100;
729 hscale will scale image horizontally to the window size;
730 vscale will scale image vertically to the window size;
731 scale will scale image to match window size;
732 root will tile image as if it was a root window background, auto-adjusting
733 whenever terminal window moves.
633 734
634Read in the specified menu file (note the `.menu' extension is 735If used in conjunction with B<-tr> option, the specified pixmap will be
635optional) and also optionally specify a starting tag to find. See the 736blended over transparency image using either alpha-blending, or any
636reference documentation for details on the syntax for the menuBar. 737other blending type, specified with B<-blt "type"> option.
637 738
638=item B<path:> I<path> 739=item B<path:> I<path>
639 740
640Specify the colon-delimited search path for finding files (XPM and 741Specify 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 742
644=item B<font:> I<fontlist> 743=item B<font:> I<fontlist>
645 744
646Select the fonts to be used. This is a comma separated list of font 745Select 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. 746that are checked in order when trying to find glyphs for characters. The
648The first font defines the cell size for characters; other fonts might 747first font defines the cell size for characters; other fonts might be
649be smaller, but not larger. A reasonable default font list is always 748smaller, but not (in general) larger. A (hopefully) reasonable default
650appended to it; option B<-fn>. 749font list is always appended to it; option B<-fn>.
651 750
652Each font can either be a standard X11 core font (XLFD) name, with 751Each 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:>. 752optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
654 753
655In addition, each font can be prefixed with additional hints and 754In addition, each font can be prefixed with additional hints and
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 756hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 757fonts.
659 758
660For example, this font resource 759For example, this font resource
661 760
662 URxvt*font: 9x15bold,\ 761 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 762 -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, \ 763 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 764 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 765 xft:Code2000:antialias=false
667 766
705 804
706=item B<intensityStyles:> I<boolean> 805=item B<intensityStyles:> I<boolean>
707 806
708When font styles are not enabled, or this option is enabled (B<True>, 807When font styles are not enabled, or this option is enabled (B<True>,
709option B<-is>, the default), bold and italic font styles imply high 808option B<-is>, the default), bold and italic font styles imply high
710intensity foreground/backround colours. Disabling this option (B<False>, 809intensity foreground/background colours. Disabling this option (B<False>,
711option B<+is>) disables this behaviour, the high intensity colours are not 810option B<+is>) disables this behaviour, the high intensity colours are not
712reachable. 811reachable.
713 812
714=item B<selectstyle:> I<mode> 813=item B<selectstyle:> I<mode>
715 814
716Set mouse selection style to B<old> which is 2.20, B<oldword> which is 815Set 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 816is xterm style with 2.20 old word selection, or anything else which
718xterm style selection. 817gives xterm style selection. Only effective when the original (non-perl)
818selection code is in use.
719 819
720=item B<scrollstyle:> I<mode> 820=item B<scrollstyle:> I<mode>
721 821
722Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 822Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
723the author's favourite. 823the author's favourite.
737=item B<mapAlert:> I<boolean> 837=item B<mapAlert:> I<boolean>
738 838
739B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 839B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
740de-iconify (map) on receipt of a bell character [default]. 840de-iconify (map) on receipt of a bell character [default].
741 841
842=item B<urgentOnBell:> I<boolean>
843
844B<True>: set the urgency hint for the wm on receipt of a bell character.
845B<False>: do not set the urgency hint [default].
846
742=item B<visualBell:> I<boolean> 847=item B<visualBell:> I<boolean>
743 848
744B<True>: use visual bell on receipt of a bell character; option B<-vb>. 849B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745B<False>: no visual bell [default]; option B<+vb>. 850B<False>: no visual bell [default]; option B<+vb>.
746 851
764 869
765The string will be interpreted as if typed into the shell as-is. 870The string will be interpreted as if typed into the shell as-is.
766 871
767Example: 872Example:
768 873
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 874 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 875
771This creates a new file in your home directory with the screen contents 876This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 877every time you hit C<Print>.
773 878
774=item B<scrollBar:> I<boolean> 879=item B<scrollBar:> I<boolean>
775 880
776B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 881B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777disable the scrollbar; option B<+sb>. 882disable the scrollbar; option B<+sb>.
799 904
800=item B<scrollWithBuffer:> I<boolean> 905=item B<scrollWithBuffer:> I<boolean>
801 906
802B<True>: scroll with scrollback buffer when tty receives new lines (and 907B<True>: scroll with scrollback buffer when tty receives new lines (and
803B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 908B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
804with scrollback buffer when tty recieves new lines; option B<+sw>. 909with scrollback buffer when tty receives new lines; option B<+sw>.
805 910
806=item B<scrollTtyKeypress:> I<boolean> 911=item B<scrollTtyKeypress:> I<boolean>
807 912
808B<True>: scroll to bottom when a non-special key is pressed. Special keys 913B<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 914are those which are intercepted by rxvt-unicode for special handling and
840=item B<termName:> I<termname> 945=item B<termName:> I<termname>
841 946
842Specifies the terminal type name to be set in the B<TERM> environment 947Specifies the terminal type name to be set in the B<TERM> environment
843variable; option B<-tn>. 948variable; option B<-tn>.
844 949
845=item B<linespace:> I<number> 950=item B<lineSpace:> I<number>
846 951
847Specifies number of lines (pixel height) to insert between each row of 952Specifies number of lines (pixel height) to insert between each row of
848the display [default 0]; option B<-lsp>. 953the display [default 0]; option B<-lsp>.
849 954
850=item B<meta8:> I<boolean> 955=item B<meta8:> I<boolean>
899pressed. If unset it will send the sequence traditionally associated 1004pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 1005with the B<Execute> key.
901 1006
902=item B<cutchars:> I<string> 1007=item B<cutchars:> I<string>
903 1008
904The characters used as delimiters for double-click word selection. The 1009The characters used as delimiters for double-click word selection
905built-in default: 1010(whitespace delimiting is added automatically if resource is given).
906 1011
1012When the perl selection extension is in use (the default if compiled
1013in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1014characters will be created (if the resource exists, otherwise, no regex
1015will be created). In this mode, characters outside ISO-8859-1 can be used.
1016
1017When the selection extension is not used, only ISO-8859-1 characters can
1018be used. If not specified, the built-in default is used:
1019
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1020B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
908 1021
909=item B<preeditType:> I<style> 1022=item B<preeditType:> I<style>
910 1023
911B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1024B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
912 1025
946default. (Note that many other terminals, including xterm, have these 1059default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 1060sequences enabled by default, which doesn't make it safer, though).
948 1061
949You can enable them by setting this boolean resource or specifying 1062You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 1063B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 1064locale, findfont, icon label and window title requests.
952menubar dispatch.
953 1065
954=item B<modifier:> I<modifier> 1066=item B<modifier:> I<modifier>
955 1067
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1068Set 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 1069B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 1073
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1074Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 1075character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 1076in the entry on B<keysym> following.
965 1077
966=item B<secondaryScreen:> I<bool> 1078=item B<secondaryScreen:> I<boolean>
967 1079
968Turn on/off secondary screen (default enabled). 1080Turn on/off secondary screen (default enabled).
969 1081
970=item B<secondaryScroll:> I<bool> 1082=item B<secondaryScroll:> I<boolean>
971 1083
972Turn on/off secondary screen scroll (default enabled). If the this 1084Turn on/off secondary screen scroll (default enabled). If this
973option is enabled, scrolls on the secondary screen will change the 1085option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 1086scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 1087instead scroll the screen up.
976 1088
977=item B<hold>: I<bool> 1089=item B<hold>: I<boolean>
978 1090
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1091Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 1092will 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 1093it exits. Instead, it will wait till it is being killed or closed by the
982user. 1094user.
1001searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1113searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1002omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1114omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1003keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1115keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1004performed in an exact manner; however, the closest match is assured. 1116performed in an exact manner; however, the closest match is assured.
1005 1117
1006I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1118I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1007C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1119number), see RESOURCES in C<man 7 X> for futher details.
1008C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1009C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1010can start or end with whitespace.
1011
1012Please 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
1014C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015processing).
1016 1120
1017You can define a range of keysyms in one shot by providing a I<string> 1121You can define a range of keysyms in one shot by providing a I<string>
1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1122with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019should be a character not used by the strings. 1123should be a character not used by the strings.
1020 1124
1021Its usage can be demonstrated by an example: 1125Its usage can be demonstrated by an example:
1022 1126
1023 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1127 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1087example, C<default,-selection> will use all the default extension except 1191example, C<default,-selection> will use all the default extension except
1088C<selection>. 1192C<selection>.
1089 1193
1090Extension names can also be followed by an argument in angle brackets 1194Extension names can also be followed by an argument in angle brackets
1091(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1195(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092searchable scorllback to Alt/Meta-s). Mentioning the same extension 1196searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093multiple times with different arguments will pass multiple arguments to 1197multiple times with different arguments will pass multiple arguments to
1094the extension. 1198the extension.
1095 1199
1096Each extension is looked up in the library directories, loaded if 1200Each extension is looked up in the library directories, loaded if
1097necessary, and bound to the current terminal instance. 1201necessary, and bound to the current terminal instance.
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1219F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1220will be ignored when running setuid/setgid.
1117 1221
1118See the @@RXVT_NAME@@perl(3) manpage. 1222See the @@RXVT_NAME@@perl(3) manpage.
1119 1223
1224=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225
1226Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1227details.
1228
1229=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1230
1231Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1232for details.
1233
1234=item B<searchable-scrollback:> I<keysym>
1235
1236Sets the hotkey that starts the incremental scrollback buffer search
1237(default: C<M-s>).
1238
1120=item B<urlLauncher>: I<string> 1239=item B<urlLauncher>: I<string>
1121 1240
1122Specifies the program to be started with a URL argument. Used by the 1241Specifies the program to be started with a URL argument. Used by the
1123C<selection-popup> and C<mark-urls> perl extensions. 1242C<selection-popup> and C<matcher> perl extensions.
1124 1243
1125=item B<transient-for>: I<windowid> 1244=item B<transient-for>: I<windowid>
1126 1245
1127Sets the WM_TRANSIENT_FOR property to the given window iw. 1246Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1247
1248=item B<override-redirect>: I<boolean>
1249
1250Compile I<frills>: Sets override-redirect for the terminal window, making
1251it almost invisible to window managers; option B<-override-redirect>.
1252
1253=item B<iso14755_52:> I<boolean>
1254
1255Turn on/off ISO 14755 5.2 mode (default enabled).
1128 1256
1129=back 1257=back
1130 1258
1131=head1 THE SCROLLBAR 1259=head1 THE SCROLLBAR
1132 1260
1151application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1279application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1152(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1280(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), 1281up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1154respectively. 1282respectively.
1155 1283
1156=head1 TEXT SELECTION AND INSERTION 1284=head1 THE SELECTION: SELECTING AND PASTING TEXT
1157 1285
1158The behaviour of text selection and insertion mechanism is similar to 1286The behaviour of text selection and insertion/pasting mechanism is similar
1159I<xterm>(1). 1287to I<xterm>(1).
1160 1288
1161=over 4 1289=over 4
1162 1290
1163=item B<Selection>: 1291=item B<Selecting>:
1164 1292
1165Left click at the beginning of the region, drag to the end of the region 1293Left 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 1294and release; Right click to extend the marked region; Left double-click
1167to select a word; Left triple-click to select the entire logical line 1295to select a word; Left triple-click to select the entire logical line
1168(which can span multiple screen lines), unless modified by resource 1296(which can span multiple screen lines), unless modified by resource
1172(Compile: I<frills>) will create a rectangular selection instead of a 1300(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 1301normal one. In this mode, every selected row becomes its own line in the
1174selection, and trailing whitespace is visually underlined and removed from 1302selection, and trailing whitespace is visually underlined and removed from
1175the selection. 1303the selection.
1176 1304
1177=item B<Insertion>: 1305=item B<Pasting>:
1178 1306
1179Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1307Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1180an B<@@RXVT_NAME@@> window causes the current text selection to be 1308window causes the value of the PRIMARY selection (or CLIPBOARD with the
1181inserted as if it had been typed on the keyboard. 1309B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1310
1311Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1312inserted too.
1182 1313
1183=back 1314=back
1184 1315
1185=head1 CHANGING FONTS 1316=head1 CHANGING FONTS
1186 1317
1187Changing fonts (or font sizes, respectively) via the keypad is not yet 1318Changing fonts (or font sizes, respectively) via the keypad is not yet
1188supported in rxvt-unicode. Bug me if you need this. 1319supported in rxvt-unicode. Bug me if you need this.
1189 1320
1190You can, however, switch fonts at runtime using escape sequences (and 1321You can, however, switch fonts at runtime using escape sequences, e.g.:
1191therefore using the menubar), e.g.:
1192 1322
1193 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1323 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1324
1325You can use keyboard shortcuts, too:
1326
1327 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1328 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1194 1329
1195rxvt-unicode will automatically re-apply these fonts to the output so far. 1330rxvt-unicode will automatically re-apply these fonts to the output so far.
1196 1331
1197=head1 ISO 14755 SUPPORT 1332=head1 ISO 14755 SUPPORT
1198 1333
1199ISO 14755 is a standard for entering and viewing unicode characters 1334ISO 14755 is a standard for entering and viewing unicode characters
1200and character codes using the keyboard. It consists of 4 parts. The 1335and character codes using the keyboard. It consists of 4 parts. The
1201first part is available rxvt-unicode has been compiled with 1336first part is available if rxvt-unicode has been compiled with
1202C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1337C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1203with C<--enable-iso14755>. 1338with C<--enable-iso14755>.
1204 1339
1205=over 4 1340=over 4
1206 1341
1226This mode lets you input characters representing the keycap symbols of 1361This mode lets you input characters representing the keycap symbols of
1227your keyboard, if representable in the current locale encoding. 1362your keyboard, if representable in the current locale encoding.
1228 1363
1229Start by pressing C<Control> and C<Shift> together, then releasing 1364Start by pressing C<Control> and C<Shift> together, then releasing
1230them. The next special key (cursor keys, home etc.) you enter will not 1365them. The next special key (cursor keys, home etc.) you enter will not
1231invoke it's usual function but instead will insert the corresponding 1366invoke its usual function but instead will insert the corresponding
1232keycap symbol. The symbol will only be entered when the key has been 1367keycap symbol. The symbol will only be entered when the key has been
1233released, otherwise pressing e.g. C<Shift> would enter the symbol for 1368released, 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 1369C<ISO Level 2 Switch>, although your intention might have been to enter a
1235reverse tab (Shift-Tab). 1370reverse tab (Shift-Tab).
1236 1371
1269=head1 COLORS AND GRAPHICS 1404=head1 COLORS AND GRAPHICS
1270 1405
1271In addition to the default foreground and background colours, 1406In addition to the default foreground and background colours,
1272B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1407B<@@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 1408high-intensity bold/blink versions of the same). Here is a list of the
1274colours with their B<rgb.txt> names. 1409colours with their names.
1275 1410
1276=begin table 1411=begin table
1277 1412
1278 B<color0> (black) = Black 1413 B<color0> (black) = Black
1279 B<color1> (red) = Red3 1414 B<color1> (red) = Red3
1299It is also possible to specify the colour values of B<foreground>, 1434It is also possible to specify the colour values of B<foreground>,
1300B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1435B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1301a number 0-15, as a convenient shorthand to reference the colour name of 1436a number 0-15, as a convenient shorthand to reference the colour name of
1302color0-color15. 1437color0-color15.
1303 1438
1439In addition to the colours defined above, @@RXVT_NAME@@ offers an
1440additional 72 colours. The first 64 of those (with indices 16 to 79)
1441consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144216>), followed by 8 additional shades of gray (with indices 80 to 87).
1443
1444Together, all those colours implement the 88 colour xterm colours. Only
1445the first 16 can be changed using resources currently, the rest can only
1446be changed via command sequences ("escape codes").
1447
1304Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1448Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1305always swapping the foreground/background colours. This is in contrast to 1449always swapping the foreground/background colours. This is in contrast to
1306I<xterm>(1) where the colours are only swapped if they have not otherwise 1450I<xterm>(1) where the colours are only swapped if they have not otherwise
1307been specified. For example, 1451been specified. For example,
1308 1452
1313would yield White on Black, while on I<xterm>(1) it would yield Black 1457would yield White on Black, while on I<xterm>(1) it would yield Black
1314on White. 1458on White.
1315 1459
1316=back 1460=back
1317 1461
1462=head2 ALPHA CHANNEL SUPPORT
1463
1464If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1465their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1466(recommended, but B<MUST> have 4 digits/component) colour specifications,
1467in addition to the ones provided by X, where the additional A component
1468specifies opacity (alpha) values. The minimum value of C<0> is completely
1469transparent). You can also prefix any color with C<[percent]>, where
1470C<percent> is a decimal percentage (0-100) that specifies the opacity of
1471the color, where C<0> is completely transparent and C<100> is completelxy
1472opaque.
1473
1474You probably need to specify B<"-depth 32">, too, and have the luck that
1475your X-server uses ARGB pixel layout, as X is far from just supporting
1476ARGB visuals out of the box, and rxvt-unicode just fudges around.
1477
1478For example, the following selects an almost completely transparent red
1479background, and an almost opaque pink foreground:
1480
1481 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1482
1483I<Please note that transparency of any kind if completely unsupported by
1484the author. Don't bug him with installation questions!>
1485
1318=head1 ENVIRONMENT 1486=head1 ENVIRONMENT
1319 1487
1320B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1488B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1321 1489
1322=over 4 1490=over 4
1323 1491
1324=item B<TERM> 1492=item B<TERM>
1325 1493
1326Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1494Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1327resources or on the commandline. 1495resources or on the command line.
1328 1496
1329=item B<COLORTERM> 1497=item B<COLORTERM>
1330 1498
1331Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1499Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1332compiled with XPM support, and optionally with the added extension 1500compiled with background image support, and optionally with the added
1333C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1501extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1502screen.
1334 1503
1335=item B<COLORFGBG> 1504=item B<COLORFGBG>
1336 1505
1337Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1506Set 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 1507the colour code used as default foreground/text colour (or the string
1339C<default> to indicate that the default-colour escape sequence is to be 1508C<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 1509used), 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@@ 1510string 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 1511was compiled with background image support. Libraries like C<ncurses>
1343(and do) use this information to optimize screen output. 1512and C<slang> can (and do) use this information to optimize screen output.
1344 1513
1345=item B<WINDOWID> 1514=item B<WINDOWID>
1346 1515
1347Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1516Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1348window, which usually has subwindows for the scrollbar, the terminal 1517window, which usually has subwindows for the scrollbar, the terminal
1354C<--with-terminfo=PATH>. 1523C<--with-terminfo=PATH>.
1355 1524
1356=item B<DISPLAY> 1525=item B<DISPLAY>
1357 1526
1358Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1527Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1359display in it's child processes. 1528display in its child processes.
1360 1529
1361=item B<SHELL> 1530=item B<SHELL>
1362 1531
1363The shell to be used for command execution, defaults to C</bin/sh>. 1532The 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 1533
1374=item B<RXVT_SOCKET> 1534=item B<RXVT_SOCKET>
1375 1535
1376The unix domain socket path used by @@RXVT_NAME@@c(1) and 1536The unix domain socket path used by @@RXVT_NAME@@c(1) and
1377@@RXVT_NAME@@d(1). 1537@@RXVT_NAME@@d(1).
1415 1575
1416=item Project Coordinator 1576=item Project Coordinator
1417 1577
1418Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1578Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1419 1579
1420L<http://software.schmorp.de/#rxvt-unicode> 1580L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1421 1581
1422=back 1582=back
1423 1583
1424=head1 AUTHORS 1584=head1 AUTHORS
1425 1585
1447 1607
1448Project Coordinator (changes.txt 2.21a to 2.4.5) 1608Project Coordinator (changes.txt 2.21a to 2.4.5)
1449 1609
1450=item Geoff Wing L<< <gcw@pobox.com> >> 1610=item Geoff Wing L<< <gcw@pobox.com> >>
1451 1611
1452Rewrote screen display and text selection routines. Project Coordinator 1612Rewrote screen display and text selection routines.
1613
1453(changes.txt 2.4.6 - rxvt-unicode) 1614Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1454 1615
1455=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1616=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1456 1617
1457Forked rxvt-unicode, rewrote most of the display code and internal 1618Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1458character handling to store text in unicode, improve xterm 1619extension, random hacks, numerous bugfixes and extensions.
1459compatibility and apply numerous other bugfixes and extensions.
1460 1620
1461Project Coordinator (Changes 1.0 -) 1621Project Coordinator (Changes 1.0 -)
1462 1622
1623=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1624
1625Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1626
1463=back 1627=back
1464 1628

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines