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.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.132 by root, Mon Jun 18 13:38:12 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 devenagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114
115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
109 118
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 120
112Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
123
124I<Please note that transparency of any kind if completely unsupported by
125the author. Don't bug him with installation questions! Read the FAQ (man 7
126@@RXVT_NAME@@)!>
114 127
115=item B<-fade> I<number> 128=item B<-fade> I<number>
116 129
117Fade the text by the given percentage when focus is lost. Small values 130Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 131fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 132colour; resource B<fading>.
120 133
121=item B<-fadecolor> I<colour> 134=item B<-fadecolor> I<colour>
122 135
123Fade to this colour when fading is used (see B<-fade>). The default colour 136Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 137is opaque black. resource B<fadeColor>.
125 138
126=item B<-tint> I<colour> 139=item B<-tint> I<colour>
127 140
128Tint the transparent background pixmap with the given colour when 141Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 142transparency is enabled with B<-tr> or B<-ip>. This only works for
131used to brighten or darken the image in addition to tinting it; resource 144used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example: 145I<tintColor>. Example:
133 146
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 147 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 148
136=item B<-sh> 149=item B<-sh> I<number>
137 150
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 151Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 152background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 153resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending; resource I<blendType>.
164
165=item B<-blr> I<number>
166
167Apply Gaussian Blur with the specified radius to the transparent
168background image; resource I<blurRadius>.
141 169
142=item B<-bg> I<colour> 170=item B<-bg> I<colour>
143 171
144Window background colour; resource B<background>. 172Window background colour; resource B<background>.
145 173
147 175
148Window foreground colour; resource B<foreground>. 176Window foreground colour; resource B<foreground>.
149 177
150=item B<-pixmap> I<file[;geom]> 178=item B<-pixmap> I<file[;geom]>
151 179
152Compile I<XPM>: Specify XPM file for the background and also optionally 180Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 181optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 182add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 183command-line; for more details see resource B<backgroundPixmap>.
156 184
157=item B<-cr> I<colour> 185=item B<-cr> I<colour>
158 186
159The cursor colour; resource B<cursorColor>. 187The cursor colour; resource B<cursorColor>.
160 188
172resource B<borderColor>. 200resource B<borderColor>.
173 201
174=item B<-fn> I<fontlist> 202=item B<-fn> I<fontlist>
175 203
176Select the fonts to be used. This is a comma separated list of font names 204Select 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 205that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 206first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 207smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 208font list is always appended to it. See resource B<font> for more details.
181 209
182In short, to specify an X11 core font, just specify it's name or prefix it 210In 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:>, 211with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 212e.g.:
185 213
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 214 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 215 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 217See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 218section of @@RXVT_NAME@@(7).
191 219
192=item B<-fb> I<fontlist> 220=item B<-fb> I<fontlist>
193 221
194Compile font-styles: The bold font list to use when B<bold> characters are to 222Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 223are to be printed. See resource B<boldFont> for details.
196 224
197=item B<-fi> I<fontlist> 225=item B<-fi> I<fontlist>
198 226
199Compile font-styles: The italic font list to use when I<italic> characters are to 227Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 228characters are to be printed. See resource B<italicFont> for details.
201 229
202=item B<-fbi> I<fontlist> 230=item B<-fbi> I<fontlist>
203 231
204Compile font-styles: The bold italic font list to use when B<< I<bold 232Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205italic> >> characters are to be printed. See resource B<boldItalicFont> 233italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 234for details.
207 235
208=item B<-is>|B<+is> 236=item B<-is>|B<+is>
209 237
210Compile font-styles: Bold/Italic font styles imply high intensity 238Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 239foreground/background (default). See resource B<intensityStyles> for
212details. 240details.
213 241
214=item B<-name> I<name> 242=item B<-name> I<name>
215 243
296=item B<-bl> 324=item B<-bl>
297 325
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 326Compile 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 327if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 328decorations; resource B<borderLess>.
329
330=item B<-override-redirect>
331
332Compile I<frills>: Sets override-redirect on the window; resource
333B<override-redirect>.
334
335=item B<-sbg>
336
337Compile I<frills>: Disable the usage of the built-in block graphics/line
338drawing characters and just rely on what the specified fonts provide. Use
339this if you have a good font and want to use its block graphic glyphs;
340resource B<skipBuiltinGlyphs>.
301 341
302=item B<-lsp> I<number> 342=item B<-lsp> I<number>
303 343
304Compile I<frills>: Lines (pixel height) to insert between each row of 344Compile I<frills>: Lines (pixel height) to insert between each row of
305the display. Useful to work around font rendering problems; resource 345the display. Useful to work around font rendering problems; resource
365for more info. 405for more info.
366 406
367=item B<-tcw> 407=item B<-tcw>
368 408
369Change the meaning of triple-click selection with the left mouse 409Change the meaning of triple-click selection with the left mouse
410button. Only effective when the original (non-perl) selection code is
370button. Instead of selecting a full line it will extend the selection the 411in-use. Instead of selecting a full line it will extend the selection the
371end of the logical line only. resource B<tripleclickwords>. 412end of the logical line only. resource B<tripleclickwords>.
372 413
373=item B<-insecure> 414=item B<-insecure>
374 415
375Enable "insecure" mode, which currently enables most of the escape 416Enable "insecure" mode, which currently enables most of the escape
403 444
404Remap a key symbol. See resource B<keysym>. 445Remap a key symbol. See resource B<keysym>.
405 446
406=item B<-embed> I<windowid> 447=item B<-embed> I<windowid>
407 448
408Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 449Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
409which enables applications to easily embed a terminal. 450which enables applications to easily embed a terminal.
410 451
411Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 452Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
412shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 453shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
413quite a bit, so don't expect it to keep some specific state. It's best to 454quite a bit, so don't expect it to keep some specific state. It's best to
416The window will not be destroyed when @@RXVT_NAME@@ exits. 457The window will not be destroyed when @@RXVT_NAME@@ exits.
417 458
418It might be useful to know that @@RXVT_NAME@@ will not close file 459It might be useful to know that @@RXVT_NAME@@ will not close file
419descriptors passed to it (except for stdin/out/err, of course), so you 460descriptors passed to it (except for stdin/out/err, of course), so you
420can use file descriptors to communicate with the programs within the 461can use file descriptors to communicate with the programs within the
421terminal. This works regardless of wether the C<-embed> option was used or 462terminal. This works regardless of whether the C<-embed> option was used or
422not. 463not.
423 464
424Here is a short Gtk2-perl snippet that illustrates how this option can be 465Here is a short Gtk2-perl snippet that illustrates how this option can be
425used (a longer example is in F<doc/embed>): 466used (a longer example is in F<doc/embed>):
426 467
428 $rxvt->signal_connect_after (realize => sub { 469 $rxvt->signal_connect_after (realize => sub {
429 my $xid = $_[0]->window->get_xid; 470 my $xid = $_[0]->window->get_xid;
430 system "@@RXVT_NAME@@ -embed $xid &"; 471 system "@@RXVT_NAME@@ -embed $xid &";
431 }); 472 });
432 473
433=item B<-pty-fd> I<fileno> 474=item B<-pty-fd> I<file descriptor>
434 475
435Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 476Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
436pair but instead use the given filehandle as the tty master. This is 477pair but instead use the given file descriptor as the tty master. This is
437useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 478useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
438without having to run a program within it. 479without having to run a program within it.
439 480
440If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 481If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
441entries and will not tinker with pty/tty permissions - you have to do that 482entries and will not tinker with pty/tty permissions - you have to do that
442yourself if you want that. 483yourself if you want that.
484
485As an extremely special case, specifying C<-1> will completely suppress
486pty/tty operations.
443 487
444Here is a example in perl that illustrates how this option can be used (a 488Here is a example in perl that illustrates how this option can be used (a
445longer example is in F<doc/pty-fd>): 489longer example is in F<doc/pty-fd>):
446 490
447 use IO::Pty; 491 use IO::Pty;
456 my $slave = $pty->slave; 500 my $slave = $pty->slave;
457 while (<$slave>) { print $slave "got <$_>\n" } 501 while (<$slave>) { print $slave "got <$_>\n" }
458 502
459=item B<-pe> I<string> 503=item B<-pe> I<string>
460 504
461Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>. 505Comma-separated list of perl extension scripts to use (or not to use) in
506this terminal instance. See resource B<perl-ext> for details.
462 507
463=back 508=back
464 509
465=head1 RESOURCES (available also as long-options) 510=head1 RESOURCES (available also as long-options)
466 511
467Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 512Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
468options) compiled into your version. 513options) compiled into your version.
469 514
470There are two different methods that @@RXVT_NAME@@ can use to get the 515You can set and change the resources using X11 tools like B<xrdb>. Many
471Xresource data: using the X libraries (Xrm*-functions) or internal 516distribution do also load settings from the B<~/.Xresources> file when X
472Xresources reader (B<~/.Xdefaults>). For the first method (ie. 517starts. @@RXVT_NAME@@ will consult the following files/resources in order,
473B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 518with later settings overwriting earlier ones:
474resources using X11 tools like B<xrdb>. Many distribution do also load
475settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476will consult the following files/resources in order, with later settings
477overwriting earlier ones:
478 519
479 1. system-wide app-defaults file, either locale-dependent OR global 520 1. system-wide app-defaults file, either locale-dependent OR global
480 2. app-defaults file in $XAPPLRESDIR 521 2. app-defaults file in $XAPPLRESDIR
481 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 522 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482 4. SCREEN_RESOURCES for the current screen 523 4. SCREEN_RESOURCES for the current screen
483 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 524 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
484 525
485If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
486lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
487set in XAPPLOADDIR/URxvt (compile-time defined: usually
488B</usr/lib/X11/app-defaults/URxvt>) and resources set in
489B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
490Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 526Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
491class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 527names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
492resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 528common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
493easily configured, while the class name B<URxvt> allows resources 529configured, while the class name B<URxvt> allows resources unique to
494unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 530B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
495shared between different B<@@RXVT_NAME@@> configurations. If no 531configurations. If no resources are specified, suitable defaults will
496resources are specified, suitable defaults will be used. Command-line 532be used. Command-line arguments can be used to override resource
497arguments can be used to override resource settings. The following 533settings. The following resources are supported (you might want to
498resources are allowed: 534check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
535extensions not documented here):
499 536
500=over 4 537=over 4
538
539=item B<depth:> I<bitdepth>
540
541Compile I<xft>: Attempt to find a visual with the given bit depth;
542option B<-depth>.
501 543
502=item B<geometry:> I<geom> 544=item B<geometry:> I<geom>
503 545
504Create the window with the specified X window geometry [default 80x24]; 546Create the window with the specified X window geometry [default 80x24];
505option B<-geometry>. 547option B<-geometry>.
542Use the specified colour to display underlined characters when the 584Use the specified colour to display underlined characters when the
543foreground colour is the default. 585foreground colour is the default.
544 586
545=item B<colorRV:> I<colour> 587=item B<colorRV:> I<colour>
546 588
547Use the specified colour as the background for reverse video 589Use the specified colour as the background for reverse video characters
548characters. 590when OPTION_HC is disabled (--disable-frills).
549 591
550=item B<underlineColor:> I<colour> 592=item B<underlineColor:> I<colour>
551 593
552If set, use the specified colour as the colour for the underline 594If set, use the specified colour as the colour for the underline
553itself. If unset, use the foreground colour. 595itself. If unset, use the foreground colour.
569option B<-rv>. B<False>: regular screen colours [default]; option 611option B<-rv>. B<False>: regular screen colours [default]; option
570B<+rv>. See note in B<COLORS AND GRAPHICS> section. 612B<+rv>. See note in B<COLORS AND GRAPHICS> section.
571 613
572=item B<jumpScroll:> I<boolean> 614=item B<jumpScroll:> I<boolean>
573 615
574B<True>: specify that jump scrolling should be used. When scrolling 616B<True>: specify that jump scrolling should be used. When receiving lots
575quickly, fewer screen updates are performed [default]; option B<-j>. 617of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
618has been read, resulting in fewer updates while still displaying every
619received line; option B<-j>.
620
576B<False>: specify that smooth scrolling should be used; option B<+j>. 621B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
622force a screen refresh on each new line it received; option B<+j>.
623
624=item B<skipScroll:> I<boolean>
625
626B<True>: (the default) specify that skip scrolling should be used. When
627receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
628(around 60 times per second), resulting in far fewer updates. This can
629result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
630option B<-ss>.
631
632B<False>: specify that everything is to be displayed, even
633if the refresh is too fast for the human eye to read anything (or the
634monitor to display anything); option B<+ss>.
577 635
578=item B<inheritPixmap:> I<boolean> 636=item B<inheritPixmap:> I<boolean>
579 637
580B<True>: make the background inherit the parent windows' pixmap, giving 638B<True>: make the background inherit the parent windows' pixmap, giving
581artificial transparency. B<False>: do not inherit the parent windows' 639artificial transparency. B<False>: do not inherit the parent windows'
582pixmap. 640pixmap.
583 641
642I<Please note that transparency of any kind if completely unsupported by
643the author. Don't bug him with installation questions!>
644
584=item B<fading:> I<number> 645=item B<fading:> I<number>
585 646
586Fade the text by the given percentage when focus is lost; option B<-fade>. 647Fade the text by the given percentage when focus is lost; option B<-fade>.
587 648
588=item B<fadeColor:> I<colour> 649=item B<fadeColor:> I<colour>
595Tint the transparent background pixmap with the given colour; option 656Tint the transparent background pixmap with the given colour; option
596B<-tint>. 657B<-tint>.
597 658
598=item B<shading:> I<number> 659=item B<shading:> I<number>
599 660
600Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 661Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
601image in addition to tinting it. 662in addition to tinting it; option B<-sh>.
663
664=item B<blendType:> I<string>
665
666Specify background blending type; option B<-blt>.
667
668=item B<blurRadius:> I<number>
669
670Apply Gaussian Blurr with the specified radius to the transparent
671background image; option B<-blr>.
602 672
603=item B<scrollColor:> I<colour> 673=item B<scrollColor:> I<colour>
604 674
605Use the specified colour for the scrollbar [default #B2B2B2]. 675Use the specified colour for the scrollbar [default #B2B2B2].
606 676
614The colour of the border around the text area and between the scrollbar 684The colour of the border around the text area and between the scrollbar
615and the text. 685and the text.
616 686
617=item B<backgroundPixmap:> I<file[;geom]> 687=item B<backgroundPixmap:> I<file[;geom]>
618 688
619Use the specified XPM file (note the `.xpm' extension is optional) for 689Use the specified image file for the background and also optionally
620the background and also optionally specify its scaling with a geometry 690specify its scaling with a geometry string B<WxH+X+Y>,
621string B<WxH+X+Y>, in which B<"W" / "H"> specify the 691in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
622horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 692and B<"X" / "Y"> locate the image centre (percent).
623centre (percent). A scale of 0 displays the image with tiling. A scale 693A scale of 0 displays the image with tiling. A scale of 1 displays the
624of 1 displays the image without any scaling. A scale of 2 to 9 694image without any scaling. A scale of 2 to 9 specifies an integer
625specifies an integer number of images in that direction. No image will 695number of images in that direction. No image will be magnified beyond
626be magnified beyond 10 times its original size. The maximum permitted 69610 times its original size. The maximum permitted scale is 1000.
627scale is 1000. [default 0x0+50+50] 697Special string of B<"auto"> used as a geometry will cause image to be
628 698automatically scaled to match window size.
629=item B<menu:> I<file[;tag]> 699If used in conjunction with B<-tr> option - specified pixmap will be
630 700blended over transparency image using either alpha-blending, or any
631Read in the specified menu file (note the `.menu' extension is 701other blending type, specified with B<-blt "type"> option.
632optional) and also optionally specify a starting tag to find. See the 702[default 0x0+50+50]
633reference documentation for details on the syntax for the menuBar.
634 703
635=item B<path:> I<path> 704=item B<path:> I<path>
636 705
637Specify the colon-delimited search path for finding files (XPM and 706Specify the colon-delimited search path for finding XPM files.
638menus), in addition to the paths specified by the B<RXVTPATH> and
639B<PATH> environment variables.
640 707
641=item B<font:> I<fontlist> 708=item B<font:> I<fontlist>
642 709
643Select the fonts to be used. This is a comma separated list of font 710Select the fonts to be used. This is a comma separated list of font names
644names that are used in turn when trying to display Unicode characters. 711that are checked in order when trying to find glyphs for characters. The
645The first font defines the cell size for characters; other fonts might 712first font defines the cell size for characters; other fonts might be
646be smaller, but not larger. A reasonable default font list is always 713smaller, but not (in general) larger. A (hopefully) reasonable default
647appended to it; option B<-fn>. 714font list is always appended to it; option B<-fn>.
648 715
649Each font can either be a standard X11 core font (XLFD) name, with 716Each font can either be a standard X11 core font (XLFD) name, with
650optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 717optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
651 718
652In addition, each font can be prefixed with additional hints and 719In addition, each font can be prefixed with additional hints and
654hint currently is C<codeset=codeset-name>, and this is only used for Xft 721hint currently is C<codeset=codeset-name>, and this is only used for Xft
655fonts. 722fonts.
656 723
657For example, this font resource 724For example, this font resource
658 725
659 URxvt*font: 9x15bold,\ 726 URxvt.font: 9x15bold,\
660 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 727 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
661 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 728 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 729 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
663 xft:Code2000:antialias=false 730 xft:Code2000:antialias=false
664 731
702 769
703=item B<intensityStyles:> I<boolean> 770=item B<intensityStyles:> I<boolean>
704 771
705When font styles are not enabled, or this option is enabled (B<True>, 772When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 773option B<-is>, the default), bold and italic font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 774intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 775option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 776reachable.
710 777
711=item B<selectstyle:> I<mode> 778=item B<selectstyle:> I<mode>
712 779
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is 780Set mouse selection style to B<old> which is 2.20, B<oldword> which
714xterm style with 2.20 old word selection, or anything else which gives 781is xterm style with 2.20 old word selection, or anything else which
715xterm style selection. 782gives xterm style selection. Only effective when the original (non-perl)
783selection code is in use.
716 784
717=item B<scrollstyle:> I<mode> 785=item B<scrollstyle:> I<mode>
718 786
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 787Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite. 788the author's favourite.
734=item B<mapAlert:> I<boolean> 802=item B<mapAlert:> I<boolean>
735 803
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 804B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 805de-iconify (map) on receipt of a bell character [default].
738 806
807=item B<urgentOnBell:> I<boolean>
808
809B<True>: set the urgency hint for the wm on receipt of a bell character.
810B<False>: do not set the urgency hint [default].
811
739=item B<visualBell:> I<boolean> 812=item B<visualBell:> I<boolean>
740 813
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 814B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 815B<False>: no visual bell [default]; option B<+vb>.
743 816
761 834
762The string will be interpreted as if typed into the shell as-is. 835The string will be interpreted as if typed into the shell as-is.
763 836
764Example: 837Example:
765 838
766 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 839 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 840
768This creates a new file in your home directory with the screen contents 841This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 842every time you hit C<Print>.
770 843
771=item B<scrollBar:> I<boolean> 844=item B<scrollBar:> I<boolean>
772 845
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 846B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 847disable the scrollbar; option B<+sb>.
796 869
797=item B<scrollWithBuffer:> I<boolean> 870=item B<scrollWithBuffer:> I<boolean>
798 871
799B<True>: scroll with scrollback buffer when tty receives new lines (and 872B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 873B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 874with scrollback buffer when tty receives new lines; option B<+sw>.
802 875
803=item B<scrollTtyKeypress:> I<boolean> 876=item B<scrollTtyKeypress:> I<boolean>
804 877
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 878B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 879are those which are intercepted by rxvt-unicode for special handling and
825=item B<borderLess:> I<boolean> 898=item B<borderLess:> I<boolean>
826 899
827Set MWM hints to request a borderless window, i.e. if honoured by the 900Set MWM hints to request a borderless window, i.e. if honoured by the
828WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 901WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
829 902
903=item B<skipBuiltinGlyphs:> I<boolean>
904
905Compile I<frills>: Disable the usage of the built-in block graphics/line
906drawing characters and just rely on what the specified fonts provide. Use
907this if you have a good font and want to use its block graphic glyphs;
908option B<-sbg>.
909
830=item B<termName:> I<termname> 910=item B<termName:> I<termname>
831 911
832Specifies the terminal type name to be set in the B<TERM> environment 912Specifies the terminal type name to be set in the B<TERM> environment
833variable; option B<-tn>. 913variable; option B<-tn>.
834 914
889pressed. If unset it will send the sequence traditionally associated 969pressed. If unset it will send the sequence traditionally associated
890with the B<Execute> key. 970with the B<Execute> key.
891 971
892=item B<cutchars:> I<string> 972=item B<cutchars:> I<string>
893 973
894The characters used as delimiters for double-click word selection. The 974The characters used as delimiters for double-click word selection
895built-in default: 975(whitespace delimiting is added automatically if resource is given).
976
977When the perl selection extension is in use (the default if compiled
978in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
979characters will be created (if the resource exists, otherwise, no regex
980will be created). In this mode, characters outside ISO-8859-1 can be used.
981
982When the selection extension is not used, only ISO-8859-1 characters can
983be used. If not specified, the built-in default is used:
896 984
897B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
898 986
899=item B<preeditType:> I<style> 987=item B<preeditType:> I<style>
900 988
936default. (Note that many other terminals, including xterm, have these 1024default. (Note that many other terminals, including xterm, have these
937sequences enabled by default, which doesn't make it safer, though). 1025sequences enabled by default, which doesn't make it safer, though).
938 1026
939You can enable them by setting this boolean resource or specifying 1027You can enable them by setting this boolean resource or specifying
940B<-insecure> as an option. At the moment, this enables display-answer, 1028B<-insecure> as an option. At the moment, this enables display-answer,
941locale, findfont, icon label and window title requests as well as dynamic 1029locale, findfont, icon label and window title requests.
942menubar dispatch.
943 1030
944=item B<modifier:> I<modifier> 1031=item B<modifier:> I<modifier>
945 1032
946Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1033Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
947B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1034B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
951 1038
952Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1039Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
953character is passed through. It may contain escape values as described 1040character is passed through. It may contain escape values as described
954in the entry on B<keysym> following. 1041in the entry on B<keysym> following.
955 1042
956=item B<secondaryScreen:> I<bool> 1043=item B<secondaryScreen:> I<boolean>
957 1044
958Turn on/off secondary screen (default enabled). 1045Turn on/off secondary screen (default enabled).
959 1046
960=item B<secondaryScroll:> I<bool> 1047=item B<secondaryScroll:> I<boolean>
961 1048
962Turn on/off secondary screen scroll (default enabled). If the this 1049Turn on/off secondary screen scroll (default enabled). If this
963option is enabled, scrolls on the secondary screen will change the 1050option is enabled, scrolls on the secondary screen will change the
964scrollback buffer and switching to/from the secondary screen will 1051scrollback buffer and switching to/from the secondary screen will
965instead scroll the screen up. 1052instead scroll the screen up.
966 1053
967=item B<hold>: I<bool> 1054=item B<hold>: I<boolean>
968 1055
969Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1056Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
970will not immediately destroy its window when the program executed within 1057will not immediately destroy its window when the program executed within
971it exits. Instead, it will wait till it is being killed or closed by the 1058it exits. Instead, it will wait till it is being killed or closed by the
972user. 1059user.
995 1082
996I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
997C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1084C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
998C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
999C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1086C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1000can start or end with whitespace. 1087can start or end with whitespace. B<This feature is deprecated and will
1088be removed>.
1001 1089
1002Please note that you need to double the C<\> when using 1090Please note that you need to double the C<\> in resource files, as
1003C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1091Xlib itself does its own de-escaping (you can use C<\033> instead of
1004use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1092C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1005@@RXVT_NAME@@'s own processing). 1093processing).
1006 1094
1007You can define a range of keysyms in one shot by providing a I<string> 1095You can define a range of keysyms in one shot by providing a I<string>
1008with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1009should be a character not used by the strings. 1097should be a character not used by the strings.
1010 1098
1011Its usage can be demonstrated by an example: 1099Its usage can be demonstrated by an example:
1012 1100
1013 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1101 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1062info): 1150info):
1063 1151
1064 URxvt.keysym.M-C-3: command:\033[8;25;80t 1152 URxvt.keysym.M-C-3: command:\033[8;25;80t
1065 URxvt.keysym.M-C-4: command:\033[8;48;110t 1153 URxvt.keysym.M-C-4: command:\033[8;48;110t
1066 1154
1155=item B<perl-ext-common>: I<string>
1156
1067=item B<perl-ext>: I<string> 1157=item B<perl-ext>: I<string>
1068 1158
1069Colon-separated list of perl extension scripts to use in this terminal 1159Comma-separated list(s) of perl extension scripts (default: C<default>) to
1160use in this terminal instance; option B<-pe>.
1161
1162Extension names can be prefixed with a C<-> sign to prohibit using
1163them. This can be useful to selectively disable some extensions loaded
1164by default, or specified via the C<perl-ext-common> resource. For
1165example, C<default,-selection> will use all the default extension except
1166C<selection>.
1167
1168Extension names can also be followed by an argument in angle brackets
1169(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1170searchable scrollback to Alt/Meta-s). Mentioning the same extension
1171multiple times with different arguments will pass multiple arguments to
1172the extension.
1173
1070instance. Each extension is looked up in the library directories, loaded 1174Each extension is looked up in the library directories, loaded if
1071if necessary, and bound to the current terminal instance. If this resource 1175necessary, and bound to the current terminal instance.
1072is empty or missing, then the perl interpreter will not be initialized; 1176
1073option B<-pe>. 1177If both of these resources are the empty string, then the perl
1178interpreter will not be initialized. The idea behind two options is that
1179B<perl-ext-common> will be used for extensions that should be available to
1180all instances, while B<perl-ext> is used for specific instances.
1074 1181
1075=item B<perl-eval>: I<string> 1182=item B<perl-eval>: I<string>
1076 1183
1077Perl code to be evaluated when all extensions have been registered. See the 1184Perl code to be evaluated when all extensions have been registered. See
1078@@RXVT_NAME@@perl(3) manpage. 1185the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1186will be ignored when running setuid/setgid.
1079 1187
1080=item B<perl-lib>: I<path> 1188=item B<perl-lib>: I<path>
1081 1189
1082Colon-separated list of additional directories that hold extension 1190Colon-separated list of additional directories that hold extension
1083scripts. When looking for extensions specified by the C<perl> resource, 1191scripts. When looking for extensions specified by the C<perl> resource,
1084@@RXVT_NAME@@ will first look in these directories and then in 1192@@RXVT_NAME@@ will first look in these directories and then in
1085F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1193F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1194will be ignored when running setuid/setgid.
1086 1195
1087See the @@RXVT_NAME@@perl(3) manpage. 1196See the @@RXVT_NAME@@perl(3) manpage.
1197
1198=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1199
1200Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1201details.
1202
1203=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1204
1205Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1206for details.
1207
1208=item B<searchable-scrollback:> I<keysym>
1209
1210Sets the hotkey that starts the incremental scrollback buffer search
1211(default: C<M-s>).
1212
1213=item B<urlLauncher>: I<string>
1214
1215Specifies the program to be started with a URL argument. Used by the
1216C<selection-popup> and C<matcher> perl extensions.
1217
1218=item B<transient-for>: I<windowid>
1219
1220Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1221
1222=item B<override-redirect>: I<boolean>
1223
1224Compile I<frills>: Sets override-redirect for the terminal window, making
1225it almost invisible to window managers; option B<-override-redirect>.
1226
1227=item B<iso14755_52:> I<boolean>
1228
1229Turn on/off ISO 14755 5.2 mode (default enabled).
1088 1230
1089=back 1231=back
1090 1232
1091=head1 THE SCROLLBAR 1233=head1 THE SCROLLBAR
1092 1234
1111application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1253application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1112(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1254(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1113up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1255up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1114respectively. 1256respectively.
1115 1257
1116=head1 TEXT SELECTION AND INSERTION 1258=head1 THE SELECTION: SELECTING AND PASTING TEXT
1117 1259
1118The behaviour of text selection and insertion mechanism is similar to 1260The behaviour of text selection and insertion/pasting mechanism is similar
1119I<xterm>(1). 1261to I<xterm>(1).
1120 1262
1121=over 4 1263=over 4
1122 1264
1123=item B<Selection>: 1265=item B<Selecting>:
1124 1266
1125Left click at the beginning of the region, drag to the end of the region 1267Left click at the beginning of the region, drag to the end of the region
1126and release; Right click to extend the marked region; Left double-click 1268and release; Right click to extend the marked region; Left double-click
1127to select a word; Left triple-click to select the entire logical line 1269to select a word; Left triple-click to select the entire logical line
1128(which can span multiple screen lines), unless modified by resource 1270(which can span multiple screen lines), unless modified by resource
1132(Compile: I<frills>) will create a rectangular selection instead of a 1274(Compile: I<frills>) will create a rectangular selection instead of a
1133normal one. In this mode, every selected row becomes its own line in the 1275normal one. In this mode, every selected row becomes its own line in the
1134selection, and trailing whitespace is visually underlined and removed from 1276selection, and trailing whitespace is visually underlined and removed from
1135the selection. 1277the selection.
1136 1278
1137=item B<Insertion>: 1279=item B<Pasting>:
1138 1280
1139Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1281Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1140an B<@@RXVT_NAME@@> window causes the current text selection to be 1282window causes the value of the PRIMARY selection (or CLIPBOARD with the
1141inserted as if it had been typed on the keyboard. 1283B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1284
1285Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1286inserted too.
1142 1287
1143=back 1288=back
1144 1289
1145=head1 CHANGING FONTS 1290=head1 CHANGING FONTS
1146 1291
1147Changing fonts (or font sizes, respectively) via the keypad is not yet 1292Changing fonts (or font sizes, respectively) via the keypad is not yet
1148supported in rxvt-unicode. Bug me if you need this. 1293supported in rxvt-unicode. Bug me if you need this.
1149 1294
1150You can, however, switch fonts at runtime using escape sequences (and 1295You can, however, switch fonts at runtime using escape sequences, e.g.:
1151therefore using the menubar), e.g.:
1152 1296
1153 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1297 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1298
1299You can use keyboard shortcuts, too:
1300
1301 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1302 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1154 1303
1155rxvt-unicode will automatically re-apply these fonts to the output so far. 1304rxvt-unicode will automatically re-apply these fonts to the output so far.
1156 1305
1157=head1 ISO 14755 SUPPORT 1306=head1 ISO 14755 SUPPORT
1158 1307
1186This mode lets you input characters representing the keycap symbols of 1335This mode lets you input characters representing the keycap symbols of
1187your keyboard, if representable in the current locale encoding. 1336your keyboard, if representable in the current locale encoding.
1188 1337
1189Start by pressing C<Control> and C<Shift> together, then releasing 1338Start by pressing C<Control> and C<Shift> together, then releasing
1190them. The next special key (cursor keys, home etc.) you enter will not 1339them. The next special key (cursor keys, home etc.) you enter will not
1191invoke it's usual function but instead will insert the corresponding 1340invoke its usual function but instead will insert the corresponding
1192keycap symbol. The symbol will only be entered when the key has been 1341keycap symbol. The symbol will only be entered when the key has been
1193released, otherwise pressing e.g. C<Shift> would enter the symbol for 1342released, otherwise pressing e.g. C<Shift> would enter the symbol for
1194C<ISO Level 2 Switch>, although your intention might have been to enter a 1343C<ISO Level 2 Switch>, although your intention might have been to enter a
1195reverse tab (Shift-Tab). 1344reverse tab (Shift-Tab).
1196 1345
1229=head1 COLORS AND GRAPHICS 1378=head1 COLORS AND GRAPHICS
1230 1379
1231In addition to the default foreground and background colours, 1380In addition to the default foreground and background colours,
1232B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1381B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1233high-intensity bold/blink versions of the same). Here is a list of the 1382high-intensity bold/blink versions of the same). Here is a list of the
1234colours with their B<rgb.txt> names. 1383colours with their names.
1235 1384
1236=begin table 1385=begin table
1237 1386
1238 B<color0> (black) = Black 1387 B<color0> (black) = Black
1239 B<color1> (red) = Red3 1388 B<color1> (red) = Red3
1259It is also possible to specify the colour values of B<foreground>, 1408It is also possible to specify the colour values of B<foreground>,
1260B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1409B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1261a number 0-15, as a convenient shorthand to reference the colour name of 1410a number 0-15, as a convenient shorthand to reference the colour name of
1262color0-color15. 1411color0-color15.
1263 1412
1413In addition to the colours defined above, @@RXVT_NAME@@ offers an
1414additional 72 colours. The first 64 of those (with indices 16 to 79)
1415consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141616>), followed by 8 additional shades of gray (with indices 80 to 87).
1417
1418Together, all those colours implement the 88 colour xterm colours. Only
1419the first 16 can be changed using resources currently, the rest can only
1420be changed via command sequences ("escape codes").
1421
1264Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1422Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1265always swapping the foreground/background colours. This is in contrast to 1423always swapping the foreground/background colours. This is in contrast to
1266I<xterm>(1) where the colours are only swapped if they have not otherwise 1424I<xterm>(1) where the colours are only swapped if they have not otherwise
1267been specified. For example, 1425been specified. For example,
1268 1426
1273would yield White on Black, while on I<xterm>(1) it would yield Black 1431would yield White on Black, while on I<xterm>(1) it would yield Black
1274on White. 1432on White.
1275 1433
1276=back 1434=back
1277 1435
1436=head2 ALPHA CHANNEL SUPPORT
1437
1438If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1439their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1440(recommended, but B<MUST> have 4 digits/component) colour specifications,
1441in addition to the ones provided by X, where the additional A component
1442specifies opacity (alpha) values. The minimum value of C<0> is completely
1443transparent). You can also prefix any color with C<[percent]>, where
1444C<percent> is a decimal percentage (0-100) that specifies the opacity of
1445the color, where C<0> is completely transparent and C<100> is completelxy
1446opaque.
1447
1448You probably need to specify B<"-depth 32">, too, and have the luck that
1449your X-server uses ARGB pixel layout, as X is far from just supporting
1450ARGB visuals out of the box, and rxvt-unicode just fudges around.
1451
1452For example, the following selects an almost completely transparent red
1453background, and an almost opaque pink foreground:
1454
1455 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1456
1457I<Please note that transparency of any kind if completely unsupported by
1458the author. Don't bug him with installation questions!>
1459
1278=head1 ENVIRONMENT 1460=head1 ENVIRONMENT
1279 1461
1280B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1462B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1281 1463
1282=over 4 1464=over 4
1283 1465
1284=item B<TERM> 1466=item B<TERM>
1285 1467
1286Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1468Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1287resources or on the commandline. 1469resources or on the command line.
1288 1470
1289=item B<COLORTERM> 1471=item B<COLORTERM>
1290 1472
1291Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1473Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1292compiled with XPM support, and optionally with the added extension 1474compiled with XPM support, and optionally with the added extension
1293C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1294 1476
1295=item B<COLORFGBG> 1477=item B<COLORFGBG>
1296 1478
1314C<--with-terminfo=PATH>. 1496C<--with-terminfo=PATH>.
1315 1497
1316=item B<DISPLAY> 1498=item B<DISPLAY>
1317 1499
1318Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1500Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1319display in it's child processes. 1501display in its child processes.
1320 1502
1321=item B<SHELL> 1503=item B<SHELL>
1322 1504
1323The shell to be used for command execution, defaults to C</bin/sh>. 1505The shell to be used for command execution, defaults to C</bin/sh>.
1324
1325=item B<RXVTPATH>
1326
1327The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1328files.
1329
1330=item B<PATH>
1331
1332Used in the same way as C<RXVTPATH>.
1333 1506
1334=item B<RXVT_SOCKET> 1507=item B<RXVT_SOCKET>
1335 1508
1336The unix domain socket path used by @@RXVT_NAME@@c(1) and 1509The unix domain socket path used by @@RXVT_NAME@@c(1) and
1337@@RXVT_NAME@@d(1). 1510@@RXVT_NAME@@d(1).
1375 1548
1376=item Project Coordinator 1549=item Project Coordinator
1377 1550
1378Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1551Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1379 1552
1380L<http://software.schmorp.de/#rxvt-unicode> 1553L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1381 1554
1382=back 1555=back
1383 1556
1384=head1 AUTHORS 1557=head1 AUTHORS
1385 1558
1407 1580
1408Project Coordinator (changes.txt 2.21a to 2.4.5) 1581Project Coordinator (changes.txt 2.21a to 2.4.5)
1409 1582
1410=item Geoff Wing L<< <gcw@pobox.com> >> 1583=item Geoff Wing L<< <gcw@pobox.com> >>
1411 1584
1412Rewrote screen display and text selection routines. Project Coordinator 1585Rewrote screen display and text selection routines.
1586
1413(changes.txt 2.4.6 - rxvt-unicode) 1587Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1414 1588
1415=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1589=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1416 1590
1417Forked rxvt-unicode, rewrote most of the display code and internal 1591Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1418character handling to store text in unicode, improve xterm 1592extension, random hacks, numerous bugfixes and extensions.
1419compatibility and apply numerous other bugfixes and extensions.
1420 1593
1421Project Coordinator (Changes 1.0 -) 1594Project Coordinator (Changes 1.0 -)
1422 1595
1596=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1597
1598Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1599
1423=back 1600=back
1424 1601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines