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.153 by root, Wed Dec 12 19:57:13 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines