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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines