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.85 by root, Wed Jan 4 20:43:37 2006 UTC vs.
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>.
123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 130
115=item B<-fade> I<number> 131=item B<-fade> I<number>
116 132
117Fade the text by the given percentage when focus is lost. Small values 133Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 135colour; resource B<fading>.
120 136
121=item B<-fadecolor> I<colour> 137=item B<-fadecolor> I<colour>
122 138
123Fade to this colour when fading is used (see B<-fade>). The default colour 139Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
125 141
126=item B<-tint> I<colour> 142=item B<-tint> I<colour>
127 143
128Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 146non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 147used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 152I<tintColor>. Example:
133 153
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 155
136=item B<-sh> 156=item B<-sh> I<number>
137 157
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 159background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 160resource I<shading>.
161
162=item B<-blt> I<string>
163
164Specify background blending type. If background pixmap is specified
165at the same time as transparency - such pixmap will be blended over
166transparency image, using method specified. Supported values are :
167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170alpha-blending. Compile I<afterimage>; resource I<blendType>.
171
172=item B<-blr> I<HxV>
173
174Apply Gaussian Blur with the specified radii to the transparent
175background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
141 180
142=item B<-bg> I<colour> 181=item B<-bg> I<colour>
143 182
144Window background colour; resource B<background>. 183Window background colour; resource B<background>.
145 184
146=item B<-fg> I<colour> 185=item B<-fg> I<colour>
147 186
148Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
149 188
150=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 190
152Compile I<XPM>: Specify XPM file for the background and also optionally 191Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 192optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
156 195
157=item B<-cr> I<colour> 196=item B<-cr> I<colour>
158 197
159The cursor colour; resource B<cursorColor>. 198The cursor colour; resource B<cursorColor>.
160 199
172resource B<borderColor>. 211resource B<borderColor>.
173 212
174=item B<-fn> I<fontlist> 213=item B<-fn> I<fontlist>
175 214
176Select the fonts to be used. This is a comma separated list of font names 215Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 216that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 217first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 218smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 219font list is always appended to it. See resource B<font> for more details.
181 220
182In short, to specify an X11 core font, just specify it's name or prefix it 221In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 222with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 223e.g.:
185 224
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 225 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 226 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
297 336
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 337Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 338if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 339decorations; resource B<borderLess>.
301 340
341=item B<-override-redirect>
342
343Compile I<frills>: Sets override-redirect on the window; resource
344B<override-redirect>.
345
302=item B<-sbg> 346=item B<-sbg>
303 347
304Compile I<frills>: Disable the usage of the built-in block graphics/line 348Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 349drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs; 350this if you have a good font and want to use its block graphic glyphs;
308 352
309=item B<-lsp> I<number> 353=item B<-lsp> I<number>
310 354
311Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
313B<linespace>. 357B<lineSpace>.
314 358
315=item B<-tn> I<termname> 359=item B<-tn> I<termname>
316 360
317This option specifies the name of the terminal type to be set in the 361This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
372for more info. 416for more info.
373 417
374=item B<-tcw> 418=item B<-tcw>
375 419
376Change the meaning of triple-click selection with the left mouse 420Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 422in-use. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>. 423end of the logical line only. resource B<tripleclickwords>.
379 424
380=item B<-insecure> 425=item B<-insecure>
381 426
382Enable "insecure" mode, which currently enables most of the escape 427Enable "insecure" mode, which currently enables most of the escape
410 455
411Remap a key symbol. See resource B<keysym>. 456Remap a key symbol. See resource B<keysym>.
412 457
413=item B<-embed> I<windowid> 458=item B<-embed> I<windowid>
414 459
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 460Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 461which enables applications to easily embed a terminal.
417 462
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 463Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 464shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 465quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 468The window will not be destroyed when @@RXVT_NAME@@ exits.
424 469
425It might be useful to know that @@RXVT_NAME@@ will not close file 470It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 471descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 472can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 473terminal. This works regardless of whether the C<-embed> option was used or
429not. 474not.
430 475
431Here is a short Gtk2-perl snippet that illustrates how this option can be 476Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 477used (a longer example is in F<doc/embed>):
433 478
435 $rxvt->signal_connect_after (realize => sub { 480 $rxvt->signal_connect_after (realize => sub {
436 my $xid = $_[0]->window->get_xid; 481 my $xid = $_[0]->window->get_xid;
437 system "@@RXVT_NAME@@ -embed $xid &"; 482 system "@@RXVT_NAME@@ -embed $xid &";
438 }); 483 });
439 484
440=item B<-pty-fd> I<fileno> 485=item B<-pty-fd> I<file descriptor>
441 486
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 487Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 488pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 489useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 490without having to run a program within it.
446 491
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 492If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 493entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that. 494yourself if you want that.
495
496As an extremely special case, specifying C<-1> will completely suppress
497pty/tty operations.
450 498
451Here is a example in perl that illustrates how this option can be used (a 499Here is a example in perl that illustrates how this option can be used (a
452longer example is in F<doc/pty-fd>): 500longer example is in F<doc/pty-fd>):
453 501
454 use IO::Pty; 502 use IO::Pty;
463 my $slave = $pty->slave; 511 my $slave = $pty->slave;
464 while (<$slave>) { print $slave "got <$_>\n" } 512 while (<$slave>) { print $slave "got <$_>\n" }
465 513
466=item B<-pe> I<string> 514=item B<-pe> I<string>
467 515
468Colon-separated list of perl extension scripts to use in this terminal 516Comma-separated list of perl extension scripts to use (or not to use) in
469instance. See resource B<perl-ext>. 517this terminal instance. See resource B<perl-ext> for details.
470 518
471=back 519=back
472 520
473=head1 RESOURCES (available also as long-options) 521=head1 RESOURCES (available also as long-options)
474 522
475Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
476options) compiled into your version. 524options) compiled into your version.
477 525
478There are two different methods that @@RXVT_NAME@@ can use to get the 526You can set and change the resources using X11 tools like B<xrdb>. Many
479Xresource data: using the X libraries (Xrm*-functions) or internal 527distribution do also load settings from the B<~/.Xresources> file when X
480Xresources reader (B<~/.Xdefaults>). For the first method (ie. 528starts. @@RXVT_NAME@@ will consult the following files/resources in order,
481B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 529with later settings overwriting earlier ones:
482resources using X11 tools like B<xrdb>. Many distribution do also load
483settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
484will consult the following files/resources in order, with later settings
485overwriting earlier ones:
486 530
487 1. system-wide app-defaults file, either locale-dependent OR global 531 1. system-wide app-defaults file, either locale-dependent OR global
488 2. app-defaults file in $XAPPLRESDIR 532 2. app-defaults file in $XAPPLRESDIR
489 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
490 4. SCREEN_RESOURCES for the current screen 534 4. SCREEN_RESOURCES for the current screen
491 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
492 536
493If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
494lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
495set in XAPPLOADDIR/URxvt (compile-time defined: usually
496B</usr/lib/X11/app-defaults/URxvt>) and resources set in
497B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
498Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
499class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
500resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 539common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
501easily configured, while the class name B<URxvt> allows resources 540configured, while the class name B<URxvt> allows resources unique to
502unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 541B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
503shared between different B<@@RXVT_NAME@@> configurations. If no 542configurations. If no resources are specified, suitable defaults will
504resources are specified, suitable defaults will be used. Command-line 543be used. Command-line arguments can be used to override resource
505arguments can be used to override resource settings. The following 544settings. The following resources are supported (you might want to
506resources are allowed: 545check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
546extensions not documented here):
507 547
508=over 4 548=over 4
549
550=item B<depth:> I<bitdepth>
551
552Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>.
509 554
510=item B<geometry:> I<geom> 555=item B<geometry:> I<geom>
511 556
512Create the window with the specified X window geometry [default 80x24]; 557Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 558option B<-geometry>.
550Use the specified colour to display underlined characters when the 595Use the specified colour to display underlined characters when the
551foreground colour is the default. 596foreground colour is the default.
552 597
553=item B<colorRV:> I<colour> 598=item B<colorRV:> I<colour>
554 599
555Use the specified colour as the background for reverse video 600Use the specified colour as the background for reverse video characters
556characters. 601when OPTION_HC is disabled (--disable-frills).
557 602
558=item B<underlineColor:> I<colour> 603=item B<underlineColor:> I<colour>
559 604
560If set, use the specified colour as the colour for the underline 605If set, use the specified colour as the colour for the underline
561itself. If unset, use the foreground colour. 606itself. If unset, use the foreground colour.
577option B<-rv>. B<False>: regular screen colours [default]; option 622option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 623B<+rv>. See note in B<COLORS AND GRAPHICS> section.
579 624
580=item B<jumpScroll:> I<boolean> 625=item B<jumpScroll:> I<boolean>
581 626
582B<True>: specify that jump scrolling should be used. When scrolling 627B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 628of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
629has been read, resulting in fewer updates while still displaying every
630received line; option B<-j>.
631
584B<False>: specify that smooth scrolling should be used; option B<+j>. 632B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
633force a screen refresh on each new line it received; option B<+j>.
634
635=item B<skipScroll:> I<boolean>
636
637B<True>: (the default) specify that skip scrolling should be used. When
638receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
639(around 60 times per second), resulting in far fewer updates. This can
640result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
641option B<-ss>.
642
643B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>.
585 646
586=item B<inheritPixmap:> I<boolean> 647=item B<inheritPixmap:> I<boolean>
587 648
588B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: make the background inherit the parent windows' pixmap, giving
589artificial transparency. B<False>: do not inherit the parent windows' 650artificial transparency. B<False>: do not inherit the parent windows'
590pixmap. 651pixmap.
591 652
653I<Please note that transparency of any kind if completely unsupported by
654the author. Don't bug him with installation questions!>
655
592=item B<fading:> I<number> 656=item B<fading:> I<number>
593 657
594Fade the text by the given percentage when focus is lost; option B<-fade>. 658Fade the text by the given percentage when focus is lost; option B<-fade>.
595 659
596=item B<fadeColor:> I<colour> 660=item B<fadeColor:> I<colour>
603Tint the transparent background pixmap with the given colour; option 667Tint the transparent background pixmap with the given colour; option
604B<-tint>. 668B<-tint>.
605 669
606=item B<shading:> I<number> 670=item B<shading:> I<number>
607 671
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 672Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609image in addition to tinting it. 673in addition to tinting it; option B<-sh>.
674
675=item B<blendType:> I<string>
676
677Specify background blending type; option B<-blt>.
678
679=item B<blurRadius:> I<number>
680
681Apply Gaussian Blurr with the specified radius to the transparent
682background image; option B<-blr>.
610 683
611=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
612 685
613Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
614 687
620=item B<borderColor:> I<colour> 693=item B<borderColor:> I<colour>
621 694
622The colour of the border around the text area and between the scrollbar 695The colour of the border around the text area and between the scrollbar
623and the text. 696and the text.
624 697
625=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626 699
627Use the specified XPM file (note the `.xpm' extension is optional) for 700Use the specified image file for the background and also optionally
628the background and also optionally specify its scaling with a geometry 701specify its scaling with a geometry string B<WxH+X+Y>,
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 702in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 703and B<"X" / "Y"> locate the image centre (percent).
631centre (percent). A scale of 0 displays the image with tiling. A scale 704A scale of 0 displays the image with tiling. A scale of 1 displays the
632of 1 displays the image without any scaling. A scale of 2 to 9 705image without any scaling. A scale of 2 to 9 specifies an integer
633specifies an integer number of images in that direction. No image will 706number of images in that direction. No image will be magnified beyond
634be magnified beyond 10 times its original size. The maximum permitted 70710 times its original size. The maximum permitted scale is 1000.
635scale is 1000. [default 0x0+50+50] 708Additional operations can be specified after colon B<:op1:op2...>.
709Supported operations are:
710 B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,
711 B<"propscale"> - will scale image keeping proportions,
712 B<"auto"> - will scale image to match window size. Equivalent to 100x100;
713 B<"hscale"> - will scale image horizontally to the window size;
714 B<"vscale"> - will scale image vertically to the window size;
715 B<"scale"> - will scale image to match window size;
716 B<"root"> - will tile image as if it was a root window background, auto-adjusting
717 whenever terminal window moves.
636 718
637=item B<menu:> I<file[;tag]> 719If used in conjunction with B<-tr> option - specified pixmap will be
638 720blended over transparency image using either alpha-blending, or any
639Read in the specified menu file (note the `.menu' extension is 721other blending type, specified with B<-blt "type"> option.
640optional) and also optionally specify a starting tag to find. See the 722[default 0x0+50+50]
641reference documentation for details on the syntax for the menuBar.
642 723
643=item B<path:> I<path> 724=item B<path:> I<path>
644 725
645Specify the colon-delimited search path for finding files (XPM and 726Specify the colon-delimited search path for finding background image files.
646menus), in addition to the paths specified by the B<RXVTPATH> and
647B<PATH> environment variables.
648 727
649=item B<font:> I<fontlist> 728=item B<font:> I<fontlist>
650 729
651Select the fonts to be used. This is a comma separated list of font 730Select the fonts to be used. This is a comma separated list of font names
652names that are used in turn when trying to display Unicode characters. 731that are checked in order when trying to find glyphs for characters. The
653The first font defines the cell size for characters; other fonts might 732first font defines the cell size for characters; other fonts might be
654be smaller, but not larger. A reasonable default font list is always 733smaller, but not (in general) larger. A (hopefully) reasonable default
655appended to it; option B<-fn>. 734font list is always appended to it; option B<-fn>.
656 735
657Each font can either be a standard X11 core font (XLFD) name, with 736Each font can either be a standard X11 core font (XLFD) name, with
658optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 737optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
659 738
660In addition, each font can be prefixed with additional hints and 739In addition, each font can be prefixed with additional hints and
662hint currently is C<codeset=codeset-name>, and this is only used for Xft 741hint currently is C<codeset=codeset-name>, and this is only used for Xft
663fonts. 742fonts.
664 743
665For example, this font resource 744For example, this font resource
666 745
667 URxvt*font: 9x15bold,\ 746 URxvt.font: 9x15bold,\
668 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 747 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
669 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 748 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
670 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 749 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
671 xft:Code2000:antialias=false 750 xft:Code2000:antialias=false
672 751
710 789
711=item B<intensityStyles:> I<boolean> 790=item B<intensityStyles:> I<boolean>
712 791
713When font styles are not enabled, or this option is enabled (B<True>, 792When font styles are not enabled, or this option is enabled (B<True>,
714option B<-is>, the default), bold and italic font styles imply high 793option B<-is>, the default), bold and italic font styles imply high
715intensity foreground/backround colours. Disabling this option (B<False>, 794intensity foreground/background colours. Disabling this option (B<False>,
716option B<+is>) disables this behaviour, the high intensity colours are not 795option B<+is>) disables this behaviour, the high intensity colours are not
717reachable. 796reachable.
718 797
719=item B<selectstyle:> I<mode> 798=item B<selectstyle:> I<mode>
720 799
721Set mouse selection style to B<old> which is 2.20, B<oldword> which is 800Set mouse selection style to B<old> which is 2.20, B<oldword> which
722xterm style with 2.20 old word selection, or anything else which gives 801is xterm style with 2.20 old word selection, or anything else which
723xterm style selection. 802gives xterm style selection. Only effective when the original (non-perl)
803selection code is in use.
724 804
725=item B<scrollstyle:> I<mode> 805=item B<scrollstyle:> I<mode>
726 806
727Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 807Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
728the author's favourite. 808the author's favourite.
742=item B<mapAlert:> I<boolean> 822=item B<mapAlert:> I<boolean>
743 823
744B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 824B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
745de-iconify (map) on receipt of a bell character [default]. 825de-iconify (map) on receipt of a bell character [default].
746 826
827=item B<urgentOnBell:> I<boolean>
828
829B<True>: set the urgency hint for the wm on receipt of a bell character.
830B<False>: do not set the urgency hint [default].
831
747=item B<visualBell:> I<boolean> 832=item B<visualBell:> I<boolean>
748 833
749B<True>: use visual bell on receipt of a bell character; option B<-vb>. 834B<True>: use visual bell on receipt of a bell character; option B<-vb>.
750B<False>: no visual bell [default]; option B<+vb>. 835B<False>: no visual bell [default]; option B<+vb>.
751 836
769 854
770The string will be interpreted as if typed into the shell as-is. 855The string will be interpreted as if typed into the shell as-is.
771 856
772Example: 857Example:
773 858
774 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 859 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
775 860
776This creates a new file in your home directory with the screen contents 861This creates a new file in your home directory with the screen contents
777everytime you hit C<Print>. 862every time you hit C<Print>.
778 863
779=item B<scrollBar:> I<boolean> 864=item B<scrollBar:> I<boolean>
780 865
781B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 866B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
782disable the scrollbar; option B<+sb>. 867disable the scrollbar; option B<+sb>.
804 889
805=item B<scrollWithBuffer:> I<boolean> 890=item B<scrollWithBuffer:> I<boolean>
806 891
807B<True>: scroll with scrollback buffer when tty receives new lines (and 892B<True>: scroll with scrollback buffer when tty receives new lines (and
808B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 893B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
809with scrollback buffer when tty recieves new lines; option B<+sw>. 894with scrollback buffer when tty receives new lines; option B<+sw>.
810 895
811=item B<scrollTtyKeypress:> I<boolean> 896=item B<scrollTtyKeypress:> I<boolean>
812 897
813B<True>: scroll to bottom when a non-special key is pressed. Special keys 898B<True>: scroll to bottom when a non-special key is pressed. Special keys
814are those which are intercepted by rxvt-unicode for special handling and 899are those which are intercepted by rxvt-unicode for special handling and
845=item B<termName:> I<termname> 930=item B<termName:> I<termname>
846 931
847Specifies the terminal type name to be set in the B<TERM> environment 932Specifies the terminal type name to be set in the B<TERM> environment
848variable; option B<-tn>. 933variable; option B<-tn>.
849 934
850=item B<linespace:> I<number> 935=item B<lineSpace:> I<number>
851 936
852Specifies number of lines (pixel height) to insert between each row of 937Specifies number of lines (pixel height) to insert between each row of
853the display [default 0]; option B<-lsp>. 938the display [default 0]; option B<-lsp>.
854 939
855=item B<meta8:> I<boolean> 940=item B<meta8:> I<boolean>
904pressed. If unset it will send the sequence traditionally associated 989pressed. If unset it will send the sequence traditionally associated
905with the B<Execute> key. 990with the B<Execute> key.
906 991
907=item B<cutchars:> I<string> 992=item B<cutchars:> I<string>
908 993
909The characters used as delimiters for double-click word selection. The 994The characters used as delimiters for double-click word selection
910built-in default: 995(whitespace delimiting is added automatically if resource is given).
996
997When the perl selection extension is in use (the default if compiled
998in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
999characters will be created (if the resource exists, otherwise, no regex
1000will be created). In this mode, characters outside ISO-8859-1 can be used.
1001
1002When the selection extension is not used, only ISO-8859-1 characters can
1003be used. If not specified, the built-in default is used:
911 1004
912B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1005B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
913 1006
914=item B<preeditType:> I<style> 1007=item B<preeditType:> I<style>
915 1008
951default. (Note that many other terminals, including xterm, have these 1044default. (Note that many other terminals, including xterm, have these
952sequences enabled by default, which doesn't make it safer, though). 1045sequences enabled by default, which doesn't make it safer, though).
953 1046
954You can enable them by setting this boolean resource or specifying 1047You can enable them by setting this boolean resource or specifying
955B<-insecure> as an option. At the moment, this enables display-answer, 1048B<-insecure> as an option. At the moment, this enables display-answer,
956locale, findfont, icon label and window title requests as well as dynamic 1049locale, findfont, icon label and window title requests.
957menubar dispatch.
958 1050
959=item B<modifier:> I<modifier> 1051=item B<modifier:> I<modifier>
960 1052
961Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1053Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
962B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1054B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
966 1058
967Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1059Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
968character is passed through. It may contain escape values as described 1060character is passed through. It may contain escape values as described
969in the entry on B<keysym> following. 1061in the entry on B<keysym> following.
970 1062
971=item B<secondaryScreen:> I<bool> 1063=item B<secondaryScreen:> I<boolean>
972 1064
973Turn on/off secondary screen (default enabled). 1065Turn on/off secondary screen (default enabled).
974 1066
975=item B<secondaryScroll:> I<bool> 1067=item B<secondaryScroll:> I<boolean>
976 1068
977Turn on/off secondary screen scroll (default enabled). If the this 1069Turn on/off secondary screen scroll (default enabled). If this
978option is enabled, scrolls on the secondary screen will change the 1070option is enabled, scrolls on the secondary screen will change the
979scrollback buffer and switching to/from the secondary screen will 1071scrollback buffer and switching to/from the secondary screen will
980instead scroll the screen up. 1072instead scroll the screen up.
981 1073
982=item B<hold>: I<bool> 1074=item B<hold>: I<boolean>
983 1075
984Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1076Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
985will not immediately destroy its window when the program executed within 1077will not immediately destroy its window when the program executed within
986it exits. Instead, it will wait till it is being killed or closed by the 1078it exits. Instead, it will wait till it is being killed or closed by the
987user. 1079user.
1006searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1098searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1007omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1099omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1008keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1100keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1009performed in an exact manner; however, the closest match is assured. 1101performed in an exact manner; however, the closest match is assured.
1010 1102
1011I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1103I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1012C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1104number), see RESOURCES in C<man 7 X> for futher details.
1013C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1014C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1015can start or end with whitespace.
1016
1017Please note that you need to double the C<\> when using
1018C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1019use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1020@@RXVT_NAME@@'s own processing).
1021 1105
1022You can define a range of keysyms in one shot by providing a I<string> 1106You can define a range of keysyms in one shot by providing a I<string>
1023with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1107with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1024should be a character not used by the strings. 1108should be a character not used by the strings.
1025 1109
1026Its usage can be demonstrated by an example: 1110Its usage can be demonstrated by an example:
1027 1111
1028 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1112 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1081 1165
1082=item B<perl-ext-common>: I<string> 1166=item B<perl-ext-common>: I<string>
1083 1167
1084=item B<perl-ext>: I<string> 1168=item B<perl-ext>: I<string>
1085 1169
1086Colon-separated list(s) of perl extension scripts to use in this terminal 1170Comma-separated list(s) of perl extension scripts (default: C<default>) to
1171use in this terminal instance; option B<-pe>.
1172
1173Extension names can be prefixed with a C<-> sign to prohibit using
1174them. This can be useful to selectively disable some extensions loaded
1175by default, or specified via the C<perl-ext-common> resource. For
1176example, C<default,-selection> will use all the default extension except
1177C<selection>.
1178
1179Extension names can also be followed by an argument in angle brackets
1180(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1181searchable scrollback to Alt/Meta-s). Mentioning the same extension
1182multiple times with different arguments will pass multiple arguments to
1183the extension.
1184
1087instance. Each extension is looked up in the library directories, loaded 1185Each extension is looked up in the library directories, loaded if
1088if necessary, and bound to the current terminal instance. If this 1186necessary, and bound to the current terminal instance.
1089resource is empty or missing, then the perl interpreter will not be 1187
1090initialized. The idea behind two options is that B<perl-ext-common> will 1188If both of these resources are the empty string, then the perl
1091be used for extensions that should be available to all instances, while 1189interpreter will not be initialized. The idea behind two options is that
1092B<perl-ext> is used for specific instances; option B<-pe>. 1190B<perl-ext-common> will be used for extensions that should be available to
1191all instances, while B<perl-ext> is used for specific instances.
1093 1192
1094=item B<perl-eval>: I<string> 1193=item B<perl-eval>: I<string>
1095 1194
1096Perl code to be evaluated when all extensions have been registered. See the 1195Perl code to be evaluated when all extensions have been registered. See
1097@@RXVT_NAME@@perl(3) manpage. 1196the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1197will be ignored when running setuid/setgid.
1098 1198
1099=item B<perl-lib>: I<path> 1199=item B<perl-lib>: I<path>
1100 1200
1101Colon-separated list of additional directories that hold extension 1201Colon-separated list of additional directories that hold extension
1102scripts. When looking for extensions specified by the C<perl> resource, 1202scripts. When looking for extensions specified by the C<perl> resource,
1103@@RXVT_NAME@@ will first look in these directories and then in 1203@@RXVT_NAME@@ will first look in these directories and then in
1104F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1204F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1205will be ignored when running setuid/setgid.
1105 1206
1106See the @@RXVT_NAME@@perl(3) manpage. 1207See the @@RXVT_NAME@@perl(3) manpage.
1208
1209=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1210
1211Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1212details.
1213
1214=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1215
1216Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1217for details.
1218
1219=item B<searchable-scrollback:> I<keysym>
1220
1221Sets the hotkey that starts the incremental scrollback buffer search
1222(default: C<M-s>).
1223
1224=item B<urlLauncher>: I<string>
1225
1226Specifies the program to be started with a URL argument. Used by the
1227C<selection-popup> and C<matcher> perl extensions.
1228
1229=item B<transient-for>: I<windowid>
1230
1231Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1232
1233=item B<override-redirect>: I<boolean>
1234
1235Compile I<frills>: Sets override-redirect for the terminal window, making
1236it almost invisible to window managers; option B<-override-redirect>.
1237
1238=item B<iso14755_52:> I<boolean>
1239
1240Turn on/off ISO 14755 5.2 mode (default enabled).
1107 1241
1108=back 1242=back
1109 1243
1110=head1 THE SCROLLBAR 1244=head1 THE SCROLLBAR
1111 1245
1130application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1264application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1131(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1265(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1132up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1266up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1133respectively. 1267respectively.
1134 1268
1135=head1 TEXT SELECTION AND INSERTION 1269=head1 THE SELECTION: SELECTING AND PASTING TEXT
1136 1270
1137The behaviour of text selection and insertion mechanism is similar to 1271The behaviour of text selection and insertion/pasting mechanism is similar
1138I<xterm>(1). 1272to I<xterm>(1).
1139 1273
1140=over 4 1274=over 4
1141 1275
1142=item B<Selection>: 1276=item B<Selecting>:
1143 1277
1144Left click at the beginning of the region, drag to the end of the region 1278Left click at the beginning of the region, drag to the end of the region
1145and release; Right click to extend the marked region; Left double-click 1279and release; Right click to extend the marked region; Left double-click
1146to select a word; Left triple-click to select the entire logical line 1280to select a word; Left triple-click to select the entire logical line
1147(which can span multiple screen lines), unless modified by resource 1281(which can span multiple screen lines), unless modified by resource
1151(Compile: I<frills>) will create a rectangular selection instead of a 1285(Compile: I<frills>) will create a rectangular selection instead of a
1152normal one. In this mode, every selected row becomes its own line in the 1286normal one. In this mode, every selected row becomes its own line in the
1153selection, and trailing whitespace is visually underlined and removed from 1287selection, and trailing whitespace is visually underlined and removed from
1154the selection. 1288the selection.
1155 1289
1156=item B<Insertion>: 1290=item B<Pasting>:
1157 1291
1158Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1292Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1159an B<@@RXVT_NAME@@> window causes the current text selection to be 1293window causes the value of the PRIMARY selection (or CLIPBOARD with the
1160inserted as if it had been typed on the keyboard. 1294B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1295
1296Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1297inserted too.
1161 1298
1162=back 1299=back
1163 1300
1164=head1 CHANGING FONTS 1301=head1 CHANGING FONTS
1165 1302
1166Changing fonts (or font sizes, respectively) via the keypad is not yet 1303Changing fonts (or font sizes, respectively) via the keypad is not yet
1167supported in rxvt-unicode. Bug me if you need this. 1304supported in rxvt-unicode. Bug me if you need this.
1168 1305
1169You can, however, switch fonts at runtime using escape sequences (and 1306You can, however, switch fonts at runtime using escape sequences, e.g.:
1170therefore using the menubar), e.g.:
1171 1307
1172 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1308 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1309
1310You can use keyboard shortcuts, too:
1311
1312 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1313 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1173 1314
1174rxvt-unicode will automatically re-apply these fonts to the output so far. 1315rxvt-unicode will automatically re-apply these fonts to the output so far.
1175 1316
1176=head1 ISO 14755 SUPPORT 1317=head1 ISO 14755 SUPPORT
1177 1318
1178ISO 14755 is a standard for entering and viewing unicode characters 1319ISO 14755 is a standard for entering and viewing unicode characters
1179and character codes using the keyboard. It consists of 4 parts. The 1320and character codes using the keyboard. It consists of 4 parts. The
1180first part is available rxvt-unicode has been compiled with 1321first part is available if rxvt-unicode has been compiled with
1181C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1322C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1182with C<--enable-iso14755>. 1323with C<--enable-iso14755>.
1183 1324
1184=over 4 1325=over 4
1185 1326
1205This mode lets you input characters representing the keycap symbols of 1346This mode lets you input characters representing the keycap symbols of
1206your keyboard, if representable in the current locale encoding. 1347your keyboard, if representable in the current locale encoding.
1207 1348
1208Start by pressing C<Control> and C<Shift> together, then releasing 1349Start by pressing C<Control> and C<Shift> together, then releasing
1209them. The next special key (cursor keys, home etc.) you enter will not 1350them. The next special key (cursor keys, home etc.) you enter will not
1210invoke it's usual function but instead will insert the corresponding 1351invoke its usual function but instead will insert the corresponding
1211keycap symbol. The symbol will only be entered when the key has been 1352keycap symbol. The symbol will only be entered when the key has been
1212released, otherwise pressing e.g. C<Shift> would enter the symbol for 1353released, otherwise pressing e.g. C<Shift> would enter the symbol for
1213C<ISO Level 2 Switch>, although your intention might have been to enter a 1354C<ISO Level 2 Switch>, although your intention might have been to enter a
1214reverse tab (Shift-Tab). 1355reverse tab (Shift-Tab).
1215 1356
1248=head1 COLORS AND GRAPHICS 1389=head1 COLORS AND GRAPHICS
1249 1390
1250In addition to the default foreground and background colours, 1391In addition to the default foreground and background colours,
1251B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1392B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1252high-intensity bold/blink versions of the same). Here is a list of the 1393high-intensity bold/blink versions of the same). Here is a list of the
1253colours with their B<rgb.txt> names. 1394colours with their names.
1254 1395
1255=begin table 1396=begin table
1256 1397
1257 B<color0> (black) = Black 1398 B<color0> (black) = Black
1258 B<color1> (red) = Red3 1399 B<color1> (red) = Red3
1278It is also possible to specify the colour values of B<foreground>, 1419It is also possible to specify the colour values of B<foreground>,
1279B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1420B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1280a number 0-15, as a convenient shorthand to reference the colour name of 1421a number 0-15, as a convenient shorthand to reference the colour name of
1281color0-color15. 1422color0-color15.
1282 1423
1424In addition to the colours defined above, @@RXVT_NAME@@ offers an
1425additional 72 colours. The first 64 of those (with indices 16 to 79)
1426consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
142716>), followed by 8 additional shades of gray (with indices 80 to 87).
1428
1429Together, all those colours implement the 88 colour xterm colours. Only
1430the first 16 can be changed using resources currently, the rest can only
1431be changed via command sequences ("escape codes").
1432
1283Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1433Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1284always swapping the foreground/background colours. This is in contrast to 1434always swapping the foreground/background colours. This is in contrast to
1285I<xterm>(1) where the colours are only swapped if they have not otherwise 1435I<xterm>(1) where the colours are only swapped if they have not otherwise
1286been specified. For example, 1436been specified. For example,
1287 1437
1292would yield White on Black, while on I<xterm>(1) it would yield Black 1442would yield White on Black, while on I<xterm>(1) it would yield Black
1293on White. 1443on White.
1294 1444
1295=back 1445=back
1296 1446
1447=head2 ALPHA CHANNEL SUPPORT
1448
1449If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1450their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1451(recommended, but B<MUST> have 4 digits/component) colour specifications,
1452in addition to the ones provided by X, where the additional A component
1453specifies opacity (alpha) values. The minimum value of C<0> is completely
1454transparent). You can also prefix any color with C<[percent]>, where
1455C<percent> is a decimal percentage (0-100) that specifies the opacity of
1456the color, where C<0> is completely transparent and C<100> is completelxy
1457opaque.
1458
1459You probably need to specify B<"-depth 32">, too, and have the luck that
1460your X-server uses ARGB pixel layout, as X is far from just supporting
1461ARGB visuals out of the box, and rxvt-unicode just fudges around.
1462
1463For example, the following selects an almost completely transparent red
1464background, and an almost opaque pink foreground:
1465
1466 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1467
1468I<Please note that transparency of any kind if completely unsupported by
1469the author. Don't bug him with installation questions!>
1470
1297=head1 ENVIRONMENT 1471=head1 ENVIRONMENT
1298 1472
1299B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1473B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1300 1474
1301=over 4 1475=over 4
1302 1476
1303=item B<TERM> 1477=item B<TERM>
1304 1478
1305Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1479Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1306resources or on the commandline. 1480resources or on the command line.
1307 1481
1308=item B<COLORTERM> 1482=item B<COLORTERM>
1309 1483
1310Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1484Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1311compiled with XPM support, and optionally with the added extension 1485compiled with background image support, and optionally with the added
1312C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1486extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1487screen.
1313 1488
1314=item B<COLORFGBG> 1489=item B<COLORFGBG>
1315 1490
1316Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1491Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1317the colour code used as default foreground/text colour (or the string 1492the colour code used as default foreground/text colour (or the string
1318C<default> to indicate that the default-colour escape sequence is to be 1493C<default> to indicate that the default-colour escape sequence is to be
1319used), C<bg> is the colour code used as default background colour (or the 1494used), C<bg> is the colour code used as default background colour (or the
1320string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1495string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1321was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1496was compiled with background image support. Libraries like C<ncurses>
1322(and do) use this information to optimize screen output. 1497and C<slang> can (and do) use this information to optimize screen output.
1323 1498
1324=item B<WINDOWID> 1499=item B<WINDOWID>
1325 1500
1326Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1501Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1327window, which usually has subwindows for the scrollbar, the terminal 1502window, which usually has subwindows for the scrollbar, the terminal
1333C<--with-terminfo=PATH>. 1508C<--with-terminfo=PATH>.
1334 1509
1335=item B<DISPLAY> 1510=item B<DISPLAY>
1336 1511
1337Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1512Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1338display in it's child processes. 1513display in its child processes.
1339 1514
1340=item B<SHELL> 1515=item B<SHELL>
1341 1516
1342The shell to be used for command execution, defaults to C</bin/sh>. 1517The shell to be used for command execution, defaults to C</bin/sh>.
1343
1344=item B<RXVTPATH>
1345
1346The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1347files.
1348
1349=item B<PATH>
1350
1351Used in the same way as C<RXVTPATH>.
1352 1518
1353=item B<RXVT_SOCKET> 1519=item B<RXVT_SOCKET>
1354 1520
1355The unix domain socket path used by @@RXVT_NAME@@c(1) and 1521The unix domain socket path used by @@RXVT_NAME@@c(1) and
1356@@RXVT_NAME@@d(1). 1522@@RXVT_NAME@@d(1).
1394 1560
1395=item Project Coordinator 1561=item Project Coordinator
1396 1562
1397Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1563Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1398 1564
1399L<http://software.schmorp.de/#rxvt-unicode> 1565L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1400 1566
1401=back 1567=back
1402 1568
1403=head1 AUTHORS 1569=head1 AUTHORS
1404 1570
1426 1592
1427Project Coordinator (changes.txt 2.21a to 2.4.5) 1593Project Coordinator (changes.txt 2.21a to 2.4.5)
1428 1594
1429=item Geoff Wing L<< <gcw@pobox.com> >> 1595=item Geoff Wing L<< <gcw@pobox.com> >>
1430 1596
1431Rewrote screen display and text selection routines. Project Coordinator 1597Rewrote screen display and text selection routines.
1598
1432(changes.txt 2.4.6 - rxvt-unicode) 1599Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1433 1600
1434=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1601=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1435 1602
1436Forked rxvt-unicode, rewrote most of the display code and internal 1603Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1437character handling to store text in unicode, improve xterm 1604extension, random hacks, numerous bugfixes and extensions.
1438compatibility and apply numerous other bugfixes and extensions.
1439 1605
1440Project Coordinator (Changes 1.0 -) 1606Project Coordinator (Changes 1.0 -)
1441 1607
1608=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1609
1610Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1611
1442=back 1612=back
1443 1613

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines