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.82 by root, Tue Jan 3 18:11:34 2006 UTC vs.
Revision 1.133 by ayin, Sat Jul 28 20:15:18 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 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 bold 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 bold characters are to 232Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 233italic> >> characters are to be printed. See resource B<boldItalicFont>
234for details.
206 235
207=item B<-is>|B<+is> 236=item B<-is>|B<+is>
208 237
209Compile font-styles: Bold/Italic font styles imply high intensity 238Compile I<font-styles>: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for 239foreground/background (default). See resource B<intensityStyles> for
211details. 240details.
212 241
213=item B<-name> I<name> 242=item B<-name> I<name>
214 243
295=item B<-bl> 324=item B<-bl>
296 325
297Compile 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.
298if 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
299decorations; 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>.
300 341
301=item B<-lsp> I<number> 342=item B<-lsp> I<number>
302 343
303Compile I<frills>: Lines (pixel height) to insert between each row of 344Compile I<frills>: Lines (pixel height) to insert between each row of
304the display. Useful to work around font rendering problems; resource 345the display. Useful to work around font rendering problems; resource
364for more info. 405for more info.
365 406
366=item B<-tcw> 407=item B<-tcw>
367 408
368Change 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
369button. 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
370end of the logical line only. resource B<tripleclickwords>. 412end of the logical line only. resource B<tripleclickwords>.
371 413
372=item B<-insecure> 414=item B<-insecure>
373 415
374Enable "insecure" mode, which currently enables most of the escape 416Enable "insecure" mode, which currently enables most of the escape
402 444
403Remap a key symbol. See resource B<keysym>. 445Remap a key symbol. See resource B<keysym>.
404 446
405=item B<-embed> I<windowid> 447=item B<-embed> I<windowid>
406 448
407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 449Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408which enables applications to easily embed a terminal. 450which enables applications to easily embed a terminal.
409 451
410Right 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
411shouldn'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
412quite 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
415The window will not be destroyed when @@RXVT_NAME@@ exits. 457The window will not be destroyed when @@RXVT_NAME@@ exits.
416 458
417It 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
418descriptors 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
419can use file descriptors to communicate with the programs within the 461can use file descriptors to communicate with the programs within the
420terminal. 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
421not. 463not.
422 464
423Here 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
424used (a longer example is in F<doc/embed>): 466used (a longer example is in F<doc/embed>):
425 467
427 $rxvt->signal_connect_after (realize => sub { 469 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid; 470 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &"; 471 system "@@RXVT_NAME@@ -embed $xid &";
430 }); 472 });
431 473
432=item B<-pty-fd> I<fileno> 474=item B<-pty-fd> I<file descriptor>
433 475
434Tells @@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
435pair 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
436useful 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
437without having to run a program within it. 479without having to run a program within it.
438 480
439If 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
440entries 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
441yourself if you want that. 483yourself if you want that.
484
485As an extremely special case, specifying C<-1> will completely suppress
486pty/tty operations.
442 487
443Here 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
444longer example is in F<doc/pty-fd>): 489longer example is in F<doc/pty-fd>):
445 490
446 use IO::Pty; 491 use IO::Pty;
455 my $slave = $pty->slave; 500 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" } 501 while (<$slave>) { print $slave "got <$_>\n" }
457 502
458=item B<-pe> I<string> 503=item B<-pe> I<string>
459 504
460Colon-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.
461 507
462=back 508=back
463 509
464=head1 RESOURCES (available also as long-options) 510=head1 RESOURCES (available also as long-options)
465 511
466Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 512Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
467options) compiled into your version. 513options) compiled into your version.
468 514
469There 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
470Xresource data: using the X libraries (Xrm*-functions) or internal 516distribution do also load settings from the B<~/.Xresources> file when X
471Xresources reader (B<~/.Xdefaults>). For the first method (ie. 517starts. @@RXVT_NAME@@ will consult the following files/resources in order,
472B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 518with later settings overwriting earlier ones:
473resources using X11 tools like B<xrdb>. Many distribution do also load
474settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475will consult the following files/resources in order, with later settings
476overwriting earlier ones:
477 519
478 1. system-wide app-defaults file, either locale-dependent OR global 520 1. system-wide app-defaults file, either locale-dependent OR global
479 2. app-defaults file in $XAPPLRESDIR 521 2. app-defaults file in $XAPPLRESDIR
480 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 522 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
481 4. SCREEN_RESOURCES for the current screen 523 4. SCREEN_RESOURCES for the current screen
482 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 524 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
483 525
484If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
485lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
486set in XAPPLOADDIR/URxvt (compile-time defined: usually
487B</usr/lib/X11/app-defaults/URxvt>) and resources set in
488B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
489Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 526Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
490class 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
491resources 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
492easily configured, while the class name B<URxvt> allows resources 529configured, while the class name B<URxvt> allows resources unique to
493unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 530B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
494shared between different B<@@RXVT_NAME@@> configurations. If no 531configurations. If no resources are specified, suitable defaults will
495resources are specified, suitable defaults will be used. Command-line 532be used. Command-line arguments can be used to override resource
496arguments can be used to override resource settings. The following 533settings. The following resources are supported (you might want to
497resources are allowed: 534check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
535extensions not documented here):
498 536
499=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>.
500 543
501=item B<geometry:> I<geom> 544=item B<geometry:> I<geom>
502 545
503Create the window with the specified X window geometry [default 80x24]; 546Create the window with the specified X window geometry [default 80x24];
504option B<-geometry>. 547option B<-geometry>.
541Use the specified colour to display underlined characters when the 584Use the specified colour to display underlined characters when the
542foreground colour is the default. 585foreground colour is the default.
543 586
544=item B<colorRV:> I<colour> 587=item B<colorRV:> I<colour>
545 588
546Use the specified colour as the background for reverse video 589Use the specified colour as the background for reverse video characters
547characters. 590when OPTION_HC is disabled (--disable-frills).
548 591
549=item B<underlineColor:> I<colour> 592=item B<underlineColor:> I<colour>
550 593
551If set, use the specified colour as the colour for the underline 594If set, use the specified colour as the colour for the underline
552itself. If unset, use the foreground colour. 595itself. If unset, use the foreground colour.
568option B<-rv>. B<False>: regular screen colours [default]; option 611option B<-rv>. B<False>: regular screen colours [default]; option
569B<+rv>. See note in B<COLORS AND GRAPHICS> section. 612B<+rv>. See note in B<COLORS AND GRAPHICS> section.
570 613
571=item B<jumpScroll:> I<boolean> 614=item B<jumpScroll:> I<boolean>
572 615
573B<True>: specify that jump scrolling should be used. When scrolling 616B<True>: specify that jump scrolling should be used. When receiving lots
574quickly, 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
575B<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>.
576 635
577=item B<inheritPixmap:> I<boolean> 636=item B<inheritPixmap:> I<boolean>
578 637
579B<True>: make the background inherit the parent windows' pixmap, giving 638B<True>: make the background inherit the parent windows' pixmap, giving
580artificial transparency. B<False>: do not inherit the parent windows' 639artificial transparency. B<False>: do not inherit the parent windows'
581pixmap. 640pixmap.
582 641
642I<Please note that transparency of any kind if completely unsupported by
643the author. Don't bug him with installation questions!>
644
583=item B<fading:> I<number> 645=item B<fading:> I<number>
584 646
585Fade 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>.
586 648
587=item B<fadeColor:> I<colour> 649=item B<fadeColor:> I<colour>
594Tint the transparent background pixmap with the given colour; option 656Tint the transparent background pixmap with the given colour; option
595B<-tint>. 657B<-tint>.
596 658
597=item B<shading:> I<number> 659=item B<shading:> I<number>
598 660
599Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 661Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
600image 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>.
601 672
602=item B<scrollColor:> I<colour> 673=item B<scrollColor:> I<colour>
603 674
604Use the specified colour for the scrollbar [default #B2B2B2]. 675Use the specified colour for the scrollbar [default #B2B2B2].
605 676
613The 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
614and the text. 685and the text.
615 686
616=item B<backgroundPixmap:> I<file[;geom]> 687=item B<backgroundPixmap:> I<file[;geom]>
617 688
618Use the specified XPM file (note the `.xpm' extension is optional) for 689Use the specified image file for the background and also optionally
619the background and also optionally specify its scaling with a geometry 690specify its scaling with a geometry string B<WxH+X+Y>,
620string B<WxH+X+Y>, in which B<"W" / "H"> specify the 691in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
621horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 692and B<"X" / "Y"> locate the image centre (percent).
622centre (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
623of 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
624specifies an integer number of images in that direction. No image will 695number of images in that direction. No image will be magnified beyond
625be magnified beyond 10 times its original size. The maximum permitted 69610 times its original size. The maximum permitted scale is 1000.
626scale is 1000. [default 0x0+50+50] 697Special string of B<"auto"> used as a geometry will cause image to be
627 698automatically scaled to match window size.
628=item B<menu:> I<file[;tag]> 699If used in conjunction with B<-tr> option - specified pixmap will be
629 700blended over transparency image using either alpha-blending, or any
630Read in the specified menu file (note the `.menu' extension is 701other blending type, specified with B<-blt "type"> option.
631optional) and also optionally specify a starting tag to find. See the 702[default 0x0+50+50]
632reference documentation for details on the syntax for the menuBar.
633 703
634=item B<path:> I<path> 704=item B<path:> I<path>
635 705
636Specify the colon-delimited search path for finding files (XPM and 706Specify the colon-delimited search path for finding XPM files.
637menus), in addition to the paths specified by the B<RXVTPATH> and
638B<PATH> environment variables.
639 707
640=item B<font:> I<fontlist> 708=item B<font:> I<fontlist>
641 709
642Select 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
643names that are used in turn when trying to display Unicode characters. 711that are checked in order when trying to find glyphs for characters. The
644The first font defines the cell size for characters; other fonts might 712first font defines the cell size for characters; other fonts might be
645be smaller, but not larger. A reasonable default font list is always 713smaller, but not (in general) larger. A (hopefully) reasonable default
646appended to it; option B<-fn>. 714font list is always appended to it; option B<-fn>.
647 715
648Each 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
649optional 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:>.
650 718
651In addition, each font can be prefixed with additional hints and 719In addition, each font can be prefixed with additional hints and
653hint 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
654fonts. 722fonts.
655 723
656For example, this font resource 724For example, this font resource
657 725
658 URxvt*font: 9x15bold,\ 726 URxvt.font: 9x15bold,\
659 -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,\
660 -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, \
661 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 729 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
662 xft:Code2000:antialias=false 730 xft:Code2000:antialias=false
663 731
701 769
702=item B<intensityStyles:> I<boolean> 770=item B<intensityStyles:> I<boolean>
703 771
704When 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>,
705option B<-is>, the default), bold and italic font styles imply high 773option B<-is>, the default), bold and italic font styles imply high
706intensity foreground/backround colours. Disabling this option (B<False>, 774intensity foreground/background colours. Disabling this option (B<False>,
707option B<+is>) disables this behaviour, the high intensity colours are not 775option B<+is>) disables this behaviour, the high intensity colours are not
708reachable. 776reachable.
709 777
710=item B<selectstyle:> I<mode> 778=item B<selectstyle:> I<mode>
711 779
712Set 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
713xterm 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
714xterm style selection. 782gives xterm style selection. Only effective when the original (non-perl)
783selection code is in use.
715 784
716=item B<scrollstyle:> I<mode> 785=item B<scrollstyle:> I<mode>
717 786
718Set 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
719the author's favourite. 788the author's favourite.
733=item B<mapAlert:> I<boolean> 802=item B<mapAlert:> I<boolean>
734 803
735B<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
736de-iconify (map) on receipt of a bell character [default]. 805de-iconify (map) on receipt of a bell character [default].
737 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
738=item B<visualBell:> I<boolean> 812=item B<visualBell:> I<boolean>
739 813
740B<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>.
741B<False>: no visual bell [default]; option B<+vb>. 815B<False>: no visual bell [default]; option B<+vb>.
742 816
760 834
761The 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.
762 836
763Example: 837Example:
764 838
765 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 839 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766 840
767This 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
768everytime you hit C<Print>. 842every time you hit C<Print>.
769 843
770=item B<scrollBar:> I<boolean> 844=item B<scrollBar:> I<boolean>
771 845
772B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 846B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
773disable the scrollbar; option B<+sb>. 847disable the scrollbar; option B<+sb>.
795 869
796=item B<scrollWithBuffer:> I<boolean> 870=item B<scrollWithBuffer:> I<boolean>
797 871
798B<True>: scroll with scrollback buffer when tty receives new lines (and 872B<True>: scroll with scrollback buffer when tty receives new lines (and
799B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 873B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
800with scrollback buffer when tty recieves new lines; option B<+sw>. 874with scrollback buffer when tty receives new lines; option B<+sw>.
801 875
802=item B<scrollTtyKeypress:> I<boolean> 876=item B<scrollTtyKeypress:> I<boolean>
803 877
804B<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
805are those which are intercepted by rxvt-unicode for special handling and 879are those which are intercepted by rxvt-unicode for special handling and
824=item B<borderLess:> I<boolean> 898=item B<borderLess:> I<boolean>
825 899
826Set 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
827WM, 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>.
828 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
829=item B<termName:> I<termname> 910=item B<termName:> I<termname>
830 911
831Specifies 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
832variable; option B<-tn>. 913variable; option B<-tn>.
833 914
888pressed. If unset it will send the sequence traditionally associated 969pressed. If unset it will send the sequence traditionally associated
889with the B<Execute> key. 970with the B<Execute> key.
890 971
891=item B<cutchars:> I<string> 972=item B<cutchars:> I<string>
892 973
893The characters used as delimiters for double-click word selection. The 974The characters used as delimiters for double-click word selection
894built-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:
895 984
896B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
897 986
898=item B<preeditType:> I<style> 987=item B<preeditType:> I<style>
899 988
935default. (Note that many other terminals, including xterm, have these 1024default. (Note that many other terminals, including xterm, have these
936sequences enabled by default, which doesn't make it safer, though). 1025sequences enabled by default, which doesn't make it safer, though).
937 1026
938You can enable them by setting this boolean resource or specifying 1027You can enable them by setting this boolean resource or specifying
939B<-insecure> as an option. At the moment, this enables display-answer, 1028B<-insecure> as an option. At the moment, this enables display-answer,
940locale, findfont, icon label and window title requests as well as dynamic 1029locale, findfont, icon label and window title requests.
941menubar dispatch.
942 1030
943=item B<modifier:> I<modifier> 1031=item B<modifier:> I<modifier>
944 1032
945Set 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>,
946B<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
950 1038
951Specify 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)
952character is passed through. It may contain escape values as described 1040character is passed through. It may contain escape values as described
953in the entry on B<keysym> following. 1041in the entry on B<keysym> following.
954 1042
955=item B<secondaryScreen:> I<bool> 1043=item B<secondaryScreen:> I<boolean>
956 1044
957Turn on/off secondary screen (default enabled). 1045Turn on/off secondary screen (default enabled).
958 1046
959=item B<secondaryScroll:> I<bool> 1047=item B<secondaryScroll:> I<boolean>
960 1048
961Turn on/off secondary screen scroll (default enabled). If the this 1049Turn on/off secondary screen scroll (default enabled). If this
962option is enabled, scrolls on the secondary screen will change the 1050option is enabled, scrolls on the secondary screen will change the
963scrollback buffer and switching to/from the secondary screen will 1051scrollback buffer and switching to/from the secondary screen will
964instead scroll the screen up. 1052instead scroll the screen up.
965 1053
966=item B<hold>: I<bool> 1054=item B<hold>: I<boolean>
967 1055
968Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1056Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969will not immediately destroy its window when the program executed within 1057will not immediately destroy its window when the program executed within
970it 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
971user. 1059user.
994 1082
995I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
996C<\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,
997C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
998C<^@>: 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
999can start or end with whitespace. 1087can start or end with whitespace. B<This feature is deprecated and will
1088be removed>.
1000 1089
1001Please note that you need to double the C<\> when using 1090Please note that you need to double the C<\> in resource files, as
1002C<--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
1003use 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
1004@@RXVT_NAME@@'s own processing). 1093processing).
1005 1094
1006You 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>
1007with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1008should be a character not used by the strings. 1097should be a character not used by the strings.
1009 1098
1010Its usage can be demonstrated by an example: 1099Its usage can be demonstrated by an example:
1011 1100
1012 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1101 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1061info): 1150info):
1062 1151
1063 URxvt.keysym.M-C-3: command:\033[8;25;80t 1152 URxvt.keysym.M-C-3: command:\033[8;25;80t
1064 URxvt.keysym.M-C-4: command:\033[8;48;110t 1153 URxvt.keysym.M-C-4: command:\033[8;48;110t
1065 1154
1155=item B<perl-ext-common>: I<string>
1156
1066=item B<perl-ext>: I<string> 1157=item B<perl-ext>: I<string>
1067 1158
1068Colon-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
1069instance. Each extension is looked up in the library directories, loaded 1174Each extension is looked up in the library directories, loaded if
1070if necessary, and bound to the current terminal instance. If this resource 1175necessary, and bound to the current terminal instance.
1071is empty or missing, then the perl interpreter will not be initialized; 1176
1072option 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.
1073 1181
1074=item B<perl-eval>: I<string> 1182=item B<perl-eval>: I<string>
1075 1183
1076Perl code to be evaluated when all extensions have been registered. See the 1184Perl code to be evaluated when all extensions have been registered. See
1077@@RXVT_NAME@@perl(3) manpage. 1185the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1186will be ignored when running setuid/setgid.
1078 1187
1079=item B<perl-lib>: I<path> 1188=item B<perl-lib>: I<path>
1080 1189
1081Colon-separated list of additional directories that hold extension 1190Colon-separated list of additional directories that hold extension
1082scripts. When looking for extensions specified by the C<perl> resource, 1191scripts. When looking for extensions specified by the C<perl> resource,
1083@@RXVT_NAME@@ will first look in these directories and then in 1192@@RXVT_NAME@@ will first look in these directories and then in
1084F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1193F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1194will be ignored when running setuid/setgid.
1085 1195
1086See 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).
1087 1230
1088=back 1231=back
1089 1232
1090=head1 THE SCROLLBAR 1233=head1 THE SCROLLBAR
1091 1234
1110application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1253application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1111(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1254(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1112up 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),
1113respectively. 1256respectively.
1114 1257
1115=head1 TEXT SELECTION AND INSERTION 1258=head1 THE SELECTION: SELECTING AND PASTING TEXT
1116 1259
1117The behaviour of text selection and insertion mechanism is similar to 1260The behaviour of text selection and insertion/pasting mechanism is similar
1118I<xterm>(1). 1261to I<xterm>(1).
1119 1262
1120=over 4 1263=over 4
1121 1264
1122=item B<Selection>: 1265=item B<Selecting>:
1123 1266
1124Left 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
1125and release; Right click to extend the marked region; Left double-click 1268and release; Right click to extend the marked region; Left double-click
1126to 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
1127(which can span multiple screen lines), unless modified by resource 1270(which can span multiple screen lines), unless modified by resource
1131(Compile: I<frills>) will create a rectangular selection instead of a 1274(Compile: I<frills>) will create a rectangular selection instead of a
1132normal 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
1133selection, and trailing whitespace is visually underlined and removed from 1276selection, and trailing whitespace is visually underlined and removed from
1134the selection. 1277the selection.
1135 1278
1136=item B<Insertion>: 1279=item B<Pasting>:
1137 1280
1138Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1281Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1139an B<@@RXVT_NAME@@> window causes the current text selection to be 1282window causes the value of the PRIMARY selection (or CLIPBOARD with the
1140inserted 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.
1141 1287
1142=back 1288=back
1143 1289
1144=head1 CHANGING FONTS 1290=head1 CHANGING FONTS
1145 1291
1146Changing fonts (or font sizes, respectively) via the keypad is not yet 1292Changing fonts (or font sizes, respectively) via the keypad is not yet
1147supported in rxvt-unicode. Bug me if you need this. 1293supported in rxvt-unicode. Bug me if you need this.
1148 1294
1149You can, however, switch fonts at runtime using escape sequences (and 1295You can, however, switch fonts at runtime using escape sequences, e.g.:
1150therefore using the menubar), e.g.:
1151 1296
1152 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
1153 1303
1154rxvt-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.
1155 1305
1156=head1 ISO 14755 SUPPORT 1306=head1 ISO 14755 SUPPORT
1157 1307
1158ISO 14755 is a standard for entering and viewing unicode characters 1308ISO 14755 is a standard for entering and viewing unicode characters
1159and character codes using the keyboard. It consists of 4 parts. The 1309and character codes using the keyboard. It consists of 4 parts. The
1160first part is available rxvt-unicode has been compiled with 1310first part is available if rxvt-unicode has been compiled with
1161C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1311C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1162with C<--enable-iso14755>. 1312with C<--enable-iso14755>.
1163 1313
1164=over 4 1314=over 4
1165 1315
1185This mode lets you input characters representing the keycap symbols of 1335This mode lets you input characters representing the keycap symbols of
1186your keyboard, if representable in the current locale encoding. 1336your keyboard, if representable in the current locale encoding.
1187 1337
1188Start by pressing C<Control> and C<Shift> together, then releasing 1338Start by pressing C<Control> and C<Shift> together, then releasing
1189them. 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
1190invoke it's usual function but instead will insert the corresponding 1340invoke its usual function but instead will insert the corresponding
1191keycap 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
1192released, otherwise pressing e.g. C<Shift> would enter the symbol for 1342released, otherwise pressing e.g. C<Shift> would enter the symbol for
1193C<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
1194reverse tab (Shift-Tab). 1344reverse tab (Shift-Tab).
1195 1345
1228=head1 COLORS AND GRAPHICS 1378=head1 COLORS AND GRAPHICS
1229 1379
1230In addition to the default foreground and background colours, 1380In addition to the default foreground and background colours,
1231B<@@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
1232high-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
1233colours with their B<rgb.txt> names. 1383colours with their names.
1234 1384
1235=begin table 1385=begin table
1236 1386
1237 B<color0> (black) = Black 1387 B<color0> (black) = Black
1238 B<color1> (red) = Red3 1388 B<color1> (red) = Red3
1258It is also possible to specify the colour values of B<foreground>, 1408It is also possible to specify the colour values of B<foreground>,
1259B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1409B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1260a 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
1261color0-color15. 1411color0-color15.
1262 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
1263Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1422Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1264always swapping the foreground/background colours. This is in contrast to 1423always swapping the foreground/background colours. This is in contrast to
1265I<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
1266been specified. For example, 1425been specified. For example,
1267 1426
1272would 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
1273on White. 1432on White.
1274 1433
1275=back 1434=back
1276 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
1277=head1 ENVIRONMENT 1460=head1 ENVIRONMENT
1278 1461
1279B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1462B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1280 1463
1281=over 4 1464=over 4
1282 1465
1283=item B<TERM> 1466=item B<TERM>
1284 1467
1285Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1468Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1286resources or on the commandline. 1469resources or on the command line.
1287 1470
1288=item B<COLORTERM> 1471=item B<COLORTERM>
1289 1472
1290Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1473Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1291compiled with XPM support, and optionally with the added extension 1474compiled with XPM support, and optionally with the added extension
1292C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1293 1476
1294=item B<COLORFGBG> 1477=item B<COLORFGBG>
1295 1478
1313C<--with-terminfo=PATH>. 1496C<--with-terminfo=PATH>.
1314 1497
1315=item B<DISPLAY> 1498=item B<DISPLAY>
1316 1499
1317Used 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
1318display in it's child processes. 1501display in its child processes.
1319 1502
1320=item B<SHELL> 1503=item B<SHELL>
1321 1504
1322The 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>.
1323
1324=item B<RXVTPATH>
1325
1326The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1327files.
1328
1329=item B<PATH>
1330
1331Used in the same way as C<RXVTPATH>.
1332 1506
1333=item B<RXVT_SOCKET> 1507=item B<RXVT_SOCKET>
1334 1508
1335The unix domain socket path used by @@RXVT_NAME@@c(1) and 1509The unix domain socket path used by @@RXVT_NAME@@c(1) and
1336@@RXVT_NAME@@d(1). 1510@@RXVT_NAME@@d(1).
1374 1548
1375=item Project Coordinator 1549=item Project Coordinator
1376 1550
1377Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1551Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1378 1552
1379L<http://software.schmorp.de/#rxvt-unicode> 1553L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1380 1554
1381=back 1555=back
1382 1556
1383=head1 AUTHORS 1557=head1 AUTHORS
1384 1558
1406 1580
1407Project Coordinator (changes.txt 2.21a to 2.4.5) 1581Project Coordinator (changes.txt 2.21a to 2.4.5)
1408 1582
1409=item Geoff Wing L<< <gcw@pobox.com> >> 1583=item Geoff Wing L<< <gcw@pobox.com> >>
1410 1584
1411Rewrote screen display and text selection routines. Project Coordinator 1585Rewrote screen display and text selection routines.
1586
1412(changes.txt 2.4.6 - rxvt-unicode) 1587Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1413 1588
1414=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1589=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1415 1590
1416Forked rxvt-unicode, rewrote most of the display code and internal 1591Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1417character handling to store text in unicode, improve xterm 1592extension, random hacks, numerous bugfixes and extensions.
1418compatibility and apply numerous other bugfixes and extensions.
1419 1593
1420Project Coordinator (Changes 1.0 -) 1594Project Coordinator (Changes 1.0 -)
1421 1595
1596=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1597
1598Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1599
1422=back 1600=back
1423 1601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines