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.76 by root, Sat Dec 31 16:06:48 2005 UTC vs.
Revision 1.129 by root, Mon May 28 20:34:56 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>
… …
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
114 123
115=item B<-fade> I<number> 124=item B<-fade> I<number>
116 125
117Fade the text by the given percentage when focus is lost. Small values 126Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 128colour; resource B<fading>.
120 129
121=item B<-fadecolor> I<colour> 130=item B<-fadecolor> I<colour>
122 131
123Fade to this colour when fading is used (see B<-fade>). The default colour 132Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 133is opaque black. resource B<fadeColor>.
125 134
126=item B<-tint> I<colour> 135=item B<-tint> I<colour>
127 136
128Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 138transparency is enabled with B<-tr> or B<-ip>. This only works for
… …
135 144
136=item B<-sh> 145=item B<-sh>
137 146
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 148background image in addition to tinting it (i.e. B<-tint> must be
140specified, too, e.g. C<-tint white>). 149specified, too, e.g. C<-tint white>); resource I<shading>.
141 150
142=item B<-bg> I<colour> 151=item B<-bg> I<colour>
143 152
144Window background colour; resource B<background>. 153Window background colour; resource B<background>.
145 154
… …
172resource B<borderColor>. 181resource B<borderColor>.
173 182
174=item B<-fn> I<fontlist> 183=item B<-fn> I<fontlist>
175 184
176Select the fonts to be used. This is a comma separated list of font names 185Select 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 186that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 187first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 188smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 189font list is always appended to it. See resource B<font> for more details.
181 190
182In short, to specify an X11 core font, just specify it's name or prefix it 191In 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:>, 192with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 193e.g.:
185 194
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 195 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 196 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
… …
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 198See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 199section of @@RXVT_NAME@@(7).
191 200
192=item B<-fb> I<fontlist> 201=item B<-fb> I<fontlist>
193 202
194Compile font-styles: The bold font list to use when bold characters are to 203Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 204are to be printed. See resource B<boldFont> for details.
196 205
197=item B<-fi> I<fontlist> 206=item B<-fi> I<fontlist>
198 207
199Compile font-styles: The italic font list to use when bold characters are to 208Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 209characters are to be printed. See resource B<italicFont> for details.
201 210
202=item B<-fbi> I<fontlist> 211=item B<-fbi> I<fontlist>
203 212
204Compile font-styles: The bold italic font list to use when bold characters are to 213Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 214italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details.
206 216
207=item B<-is>|B<+is> 217=item B<-is>|B<+is>
208 218
209Compile font-styles: Bold/Italic font styles imply high intensity 219Compile I<font-styles>: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for 220foreground/background (default). See resource B<intensityStyles> for
211details. 221details.
212 222
213=item B<-name> I<name> 223=item B<-name> I<name>
214 224
… …
295=item B<-bl> 305=item B<-bl>
296 306
297Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile 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 308if honoured by the WM, the rxvt-unicode window will not have window
299decorations; resource B<borderLess>. 309decorations; resource B<borderLess>.
310
311=item B<-override-redirect>
312
313Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>.
315
316=item B<-sbg>
317
318Compile I<frills>: Disable the usage of the built-in block graphics/line
319drawing characters and just rely on what the specified fonts provide. Use
320this if you have a good font and want to use its block graphic glyphs;
321resource B<skipBuiltinGlyphs>.
300 322
301=item B<-lsp> I<number> 323=item B<-lsp> I<number>
302 324
303Compile I<frills>: Lines (pixel height) to insert between each row of 325Compile I<frills>: Lines (pixel height) to insert between each row of
304the display. Useful to work around font rendering problems; resource 326the display. Useful to work around font rendering problems; resource
… …
364for more info. 386for more info.
365 387
366=item B<-tcw> 388=item B<-tcw>
367 389
368Change the meaning of triple-click selection with the left mouse 390Change the meaning of triple-click selection with the left mouse
391button. Only effective when the original (non-perl) selection code is
369button. Instead of selecting a full line it will extend the selection the 392in-use. Instead of selecting a full line it will extend the selection the
370end of the logical line only. resource B<tripleclickwords>. 393end of the logical line only. resource B<tripleclickwords>.
371 394
372=item B<-insecure> 395=item B<-insecure>
373 396
374Enable "insecure" mode, which currently enables most of the escape 397Enable "insecure" mode, which currently enables most of the escape
… …
402 425
403Remap a key symbol. See resource B<keysym>. 426Remap a key symbol. See resource B<keysym>.
404 427
405=item B<-embed> I<windowid> 428=item B<-embed> I<windowid>
406 429
407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 430Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408which enables applications to easily embed a terminal. 431which enables applications to easily embed a terminal.
409 432
410Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 433Right 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 434shouldn'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 435quite 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. 438The window will not be destroyed when @@RXVT_NAME@@ exits.
416 439
417It might be useful to know that @@RXVT_NAME@@ will not close file 440It 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 441descriptors passed to it (except for stdin/out/err, of course), so you
419can use file descriptors to communicate with the programs within the 442can use file descriptors to communicate with the programs within the
420terminal. This works regardless of wether the C<-embed> option was used or 443terminal. This works regardless of whether the C<-embed> option was used or
421not. 444not.
422 445
423Here is a short Gtk2-perl snippet that illustrates how this option can be 446Here is a short Gtk2-perl snippet that illustrates how this option can be
424used (a longer example is in F<doc/embed>): 447used (a longer example is in F<doc/embed>):
425 448
… …
427 $rxvt->signal_connect_after (realize => sub { 450 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid; 451 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &"; 452 system "@@RXVT_NAME@@ -embed $xid &";
430 }); 453 });
431 454
432=item B<-pty-fd> I<fileno> 455=item B<-pty-fd> I<file descriptor>
433 456
434Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 457Tells @@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 458pair 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 459useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437without having to run a program within it. 460without having to run a program within it.
438 461
439If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 462If 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 463entries and will not tinker with pty/tty permissions - you have to do that
441yourself if you want that. 464yourself if you want that.
465
466As an extremely special case, specifying C<-1> will completely suppress
467pty/tty operations.
442 468
443Here is a example in perl that illustrates how this option can be used (a 469Here is a example in perl that illustrates how this option can be used (a
444longer example is in F<doc/pty-fd>): 470longer example is in F<doc/pty-fd>):
445 471
446 use IO::Pty; 472 use IO::Pty;
… …
453 479
454 # now communicate with rxvt 480 # now communicate with rxvt
455 my $slave = $pty->slave; 481 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" } 482 while (<$slave>) { print $slave "got <$_>\n" }
457 483
484=item B<-pe> I<string>
485
486Comma-separated list of perl extension scripts to use (or not to use) in
487this terminal instance. See resource B<perl-ext> for details.
488
458=back 489=back
459 490
460=head1 RESOURCES (available also as long-options) 491=head1 RESOURCES (available also as long-options)
461 492
462Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 493Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
463options) compiled into your version. 494options) compiled into your version.
464 495
465There are two different methods that @@RXVT_NAME@@ can use to get the 496You can set and change the resources using X11 tools like B<xrdb>. Many
466Xresource data: using the X libraries (Xrm*-functions) or internal 497distribution do also load settings from the B<~/.Xresources> file when X
467Xresources reader (B<~/.Xdefaults>). For the first method (ie. 498starts. @@RXVT_NAME@@ will consult the following files/resources in order,
468B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 499with later settings overwriting earlier ones:
469resources using X11 tools like B<xrdb>. Many distribution do also load
470settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
471will consult the following files/resources in order, with later settings
472overwriting earlier ones:
473 500
474 1. system-wide app-defaults file, either locale-dependent OR global 501 1. system-wide app-defaults file, either locale-dependent OR global
475 2. app-defaults file in $XAPPLRESDIR 502 2. app-defaults file in $XAPPLRESDIR
476 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 503 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
477 4. SCREEN_RESOURCES for the current screen 504 4. SCREEN_RESOURCES for the current screen
478 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 505 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
479 506
480If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
481lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
482set in XAPPLOADDIR/URxvt (compile-time defined: usually
483B</usr/lib/X11/app-defaults/URxvt>) and resources set in
484B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
485Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 507Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
486class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 508names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
487resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 509common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
488easily configured, while the class name B<URxvt> allows resources 510configured, while the class name B<URxvt> allows resources unique to
489unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 511B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
490shared between different B<@@RXVT_NAME@@> configurations. If no 512configurations. If no resources are specified, suitable defaults will
491resources are specified, suitable defaults will be used. Command-line 513be used. Command-line arguments can be used to override resource
492arguments can be used to override resource settings. The following 514settings. The following resources are supported (you might want to
493resources are allowed: 515check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
516extensions not documented here):
494 517
495=over 4 518=over 4
519
520=item B<depth:> I<bitdepth>
521
522Compile I<xft>: Attempt to find a visual with the given bit depth;
523option B<-depth>.
496 524
497=item B<geometry:> I<geom> 525=item B<geometry:> I<geom>
498 526
499Create the window with the specified X window geometry [default 80x24]; 527Create the window with the specified X window geometry [default 80x24];
500option B<-geometry>. 528option B<-geometry>.
… …
537Use the specified colour to display underlined characters when the 565Use the specified colour to display underlined characters when the
538foreground colour is the default. 566foreground colour is the default.
539 567
540=item B<colorRV:> I<colour> 568=item B<colorRV:> I<colour>
541 569
542Use the specified colour as the background for reverse video 570Use the specified colour as the background for reverse video characters
543characters. 571when OPTION_HC is disabled (--disable-frills).
544 572
545=item B<underlineColor:> I<colour> 573=item B<underlineColor:> I<colour>
546 574
547If set, use the specified colour as the colour for the underline 575If set, use the specified colour as the colour for the underline
548itself. If unset, use the foreground colour. 576itself. If unset, use the foreground colour.
… …
574 602
575B<True>: make the background inherit the parent windows' pixmap, giving 603B<True>: make the background inherit the parent windows' pixmap, giving
576artificial transparency. B<False>: do not inherit the parent windows' 604artificial transparency. B<False>: do not inherit the parent windows'
577pixmap. 605pixmap.
578 606
607I<Please note that transparency of any kind if completely unsupported by
608the author. Don't bug him with installation questions!>
609
579=item B<fading:> I<number> 610=item B<fading:> I<number>
580 611
581Fade the text by the given percentage when focus is lost; option B<-fade>. 612Fade the text by the given percentage when focus is lost; option B<-fade>.
582 613
583=item B<fadeColor:> I<colour> 614=item B<fadeColor:> I<colour>
… …
590Tint the transparent background pixmap with the given colour; option 621Tint the transparent background pixmap with the given colour; option
591B<-tint>. 622B<-tint>.
592 623
593=item B<shading:> I<number> 624=item B<shading:> I<number>
594 625
595Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 626Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
596image in addition to tinting it. 627in addition to tinting it; option B<-sh>.
597 628
598=item B<scrollColor:> I<colour> 629=item B<scrollColor:> I<colour>
599 630
600Use the specified colour for the scrollbar [default #B2B2B2]. 631Use the specified colour for the scrollbar [default #B2B2B2].
601 632
… …
619of 1 displays the image without any scaling. A scale of 2 to 9 650of 1 displays the image without any scaling. A scale of 2 to 9
620specifies an integer number of images in that direction. No image will 651specifies an integer number of images in that direction. No image will
621be magnified beyond 10 times its original size. The maximum permitted 652be magnified beyond 10 times its original size. The maximum permitted
622scale is 1000. [default 0x0+50+50] 653scale is 1000. [default 0x0+50+50]
623 654
624=item B<menu:> I<file[;tag]>
625
626Read in the specified menu file (note the `.menu' extension is
627optional) and also optionally specify a starting tag to find. See the
628reference documentation for details on the syntax for the menuBar.
629
630=item B<path:> I<path> 655=item B<path:> I<path>
631 656
632Specify the colon-delimited search path for finding files (XPM and 657Specify the colon-delimited search path for finding XPM files.
633menus), in addition to the paths specified by the B<RXVTPATH> and
634B<PATH> environment variables.
635 658
636=item B<font:> I<fontlist> 659=item B<font:> I<fontlist>
637 660
638Select the fonts to be used. This is a comma separated list of font 661Select the fonts to be used. This is a comma separated list of font names
639names that are used in turn when trying to display Unicode characters. 662that are checked in order when trying to find glyphs for characters. The
640The first font defines the cell size for characters; other fonts might 663first font defines the cell size for characters; other fonts might be
641be smaller, but not larger. A reasonable default font list is always 664smaller, but not (in general) larger. A (hopefully) reasonable default
642appended to it. option B<-fn>. 665font list is always appended to it; option B<-fn>.
643 666
644Each font can either be a standard X11 core font (XLFD) name, with 667Each font can either be a standard X11 core font (XLFD) name, with
645optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 668optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
646 669
647In addition, each font can be prefixed with additional hints and 670In addition, each font can be prefixed with additional hints and
… …
649hint currently is C<codeset=codeset-name>, and this is only used for Xft 672hint currently is C<codeset=codeset-name>, and this is only used for Xft
650fonts. 673fonts.
651 674
652For example, this font resource 675For example, this font resource
653 676
654 URxvt*font: 9x15bold,\ 677 URxvt.font: 9x15bold,\
655 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 678 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
656 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 679 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
657 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 680 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
658 xft:Code2000:antialias=false 681 xft:Code2000:antialias=false
659 682
… …
697 720
698=item B<intensityStyles:> I<boolean> 721=item B<intensityStyles:> I<boolean>
699 722
700When font styles are not enabled, or this option is enabled (B<True>, 723When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high 724option B<-is>, the default), bold and italic font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>, 725intensity foreground/background colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not 726option B<+is>) disables this behaviour, the high intensity colours are not
704reachable. 727reachable.
705 728
706=item B<selectstyle:> I<mode> 729=item B<selectstyle:> I<mode>
707 730
708Set mouse selection style to B<old> which is 2.20, B<oldword> which is 731Set mouse selection style to B<old> which is 2.20, B<oldword> which
709xterm style with 2.20 old word selection, or anything else which gives 732is xterm style with 2.20 old word selection, or anything else which
710xterm style selection. 733gives xterm style selection. Only effective when the original (non-perl)
734selection code is in use.
711 735
712=item B<scrollstyle:> I<mode> 736=item B<scrollstyle:> I<mode>
713 737
714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 738Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715the author's favourite. 739the author's favourite.
… …
729=item B<mapAlert:> I<boolean> 753=item B<mapAlert:> I<boolean>
730 754
731B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 755B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732de-iconify (map) on receipt of a bell character [default]. 756de-iconify (map) on receipt of a bell character [default].
733 757
758=item B<urgentOnBell:> I<boolean>
759
760B<True>: set the urgency hint for the wm on receipt of a bell character.
761B<False>: do not set the urgency hint [default].
762
734=item B<visualBell:> I<boolean> 763=item B<visualBell:> I<boolean>
735 764
736B<True>: use visual bell on receipt of a bell character; option B<-vb>. 765B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737B<False>: no visual bell [default]; option B<+vb>. 766B<False>: no visual bell [default]; option B<+vb>.
738 767
… …
756 785
757The string will be interpreted as if typed into the shell as-is. 786The string will be interpreted as if typed into the shell as-is.
758 787
759Example: 788Example:
760 789
761 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 790 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 791
763This creates a new file in your home directory with the screen contents 792This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>. 793every time you hit C<Print>.
765 794
766=item B<scrollBar:> I<boolean> 795=item B<scrollBar:> I<boolean>
767 796
768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 797B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769disable the scrollbar; option B<+sb>. 798disable the scrollbar; option B<+sb>.
… …
791 820
792=item B<scrollWithBuffer:> I<boolean> 821=item B<scrollWithBuffer:> I<boolean>
793 822
794B<True>: scroll with scrollback buffer when tty receives new lines (and 823B<True>: scroll with scrollback buffer when tty receives new lines (and
795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 824B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
796with scrollback buffer when tty recieves new lines; option B<+sw>. 825with scrollback buffer when tty receives new lines; option B<+sw>.
797 826
798=item B<scrollTtyKeypress:> I<boolean> 827=item B<scrollTtyKeypress:> I<boolean>
799 828
800B<True>: scroll to bottom when a non-special key is pressed. Special keys 829B<True>: scroll to bottom when a non-special key is pressed. Special keys
801are those which are intercepted by rxvt-unicode for special handling and 830are those which are intercepted by rxvt-unicode for special handling and
… …
820=item B<borderLess:> I<boolean> 849=item B<borderLess:> I<boolean>
821 850
822Set MWM hints to request a borderless window, i.e. if honoured by the 851Set MWM hints to request a borderless window, i.e. if honoured by the
823WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 852WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
824 853
854=item B<skipBuiltinGlyphs:> I<boolean>
855
856Compile I<frills>: Disable the usage of the built-in block graphics/line
857drawing characters and just rely on what the specified fonts provide. Use
858this if you have a good font and want to use its block graphic glyphs;
859option B<-sbg>.
860
825=item B<termName:> I<termname> 861=item B<termName:> I<termname>
826 862
827Specifies the terminal type name to be set in the B<TERM> environment 863Specifies the terminal type name to be set in the B<TERM> environment
828variable; option B<-tn>. 864variable; option B<-tn>.
829 865
… …
884pressed. If unset it will send the sequence traditionally associated 920pressed. If unset it will send the sequence traditionally associated
885with the B<Execute> key. 921with the B<Execute> key.
886 922
887=item B<cutchars:> I<string> 923=item B<cutchars:> I<string>
888 924
889The characters used as delimiters for double-click word selection. The 925The characters used as delimiters for double-click word selection
890built-in default: 926(whitespace delimiting is added automatically if resource is given).
927
928When the perl selection extension is in use (the default if compiled
929in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
930characters will be created (if the resource exists, otherwise, no regex
931will be created). In this mode, characters outside ISO-8859-1 can be used.
932
933When the selection extension is not used, only ISO-8859-1 characters can
934be used. If not specified, the built-in default is used:
891 935
892B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 936B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
893 937
894=item B<preeditType:> I<style> 938=item B<preeditType:> I<style>
895 939
… …
902=item B<imLocale:> I<name> 946=item B<imLocale:> I<name>
903 947
904The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 948The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
905C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 949C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
906input extension to be able to input japanese characters while staying in 950input extension to be able to input japanese characters while staying in
907another locale. option B<-imlocale>. 951another locale; option B<-imlocale>.
908 952
909=item B<imFont:> I<fontset> 953=item B<imFont:> I<fontset>
910 954
911Specify the font-set used for XIM styles C<OverTheSpot> or 955Specify the font-set used for XIM styles C<OverTheSpot> or
912C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 956C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
… …
917 961
918=item B<tripleclickwords:> I<boolean> 962=item B<tripleclickwords:> I<boolean>
919 963
920Change the meaning of triple-click selection with the left mouse 964Change the meaning of triple-click selection with the left mouse
921button. Instead of selecting a full line it will extend the selection to 965button. Instead of selecting a full line it will extend the selection to
922the end of the logical line only. option B<-tcw>. 966the end of the logical line only; option B<-tcw>.
923 967
924=item B<insecure:> I<boolean> 968=item B<insecure:> I<boolean>
925 969
926Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 970Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
927echo arbitrary strings like the icon name or the locale. This could be 971echo arbitrary strings like the icon name or the locale. This could be
… …
931default. (Note that many other terminals, including xterm, have these 975default. (Note that many other terminals, including xterm, have these
932sequences enabled by default, which doesn't make it safer, though). 976sequences enabled by default, which doesn't make it safer, though).
933 977
934You can enable them by setting this boolean resource or specifying 978You can enable them by setting this boolean resource or specifying
935B<-insecure> as an option. At the moment, this enables display-answer, 979B<-insecure> as an option. At the moment, this enables display-answer,
936locale, findfont, icon label and window title requests as well as dynamic 980locale, findfont, icon label and window title requests.
937menubar dispatch.
938 981
939=item B<modifier:> I<modifier> 982=item B<modifier:> I<modifier>
940 983
941Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 984Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
942B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 985B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
946 989
947Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 990Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
948character is passed through. It may contain escape values as described 991character is passed through. It may contain escape values as described
949in the entry on B<keysym> following. 992in the entry on B<keysym> following.
950 993
951=item B<secondaryScreen:> I<bool> 994=item B<secondaryScreen:> I<boolean>
952 995
953Turn on/off secondary screen (default enabled). 996Turn on/off secondary screen (default enabled).
954 997
955=item B<secondaryScroll:> I<bool> 998=item B<secondaryScroll:> I<boolean>
956 999
957Turn on/off secondary screen scroll (default enabled). If the this 1000Turn on/off secondary screen scroll (default enabled). If this
958option is enabled, scrolls on the secondary screen will change the 1001option is enabled, scrolls on the secondary screen will change the
959scrollback buffer and switching to/from the secondary screen will 1002scrollback buffer and switching to/from the secondary screen will
960instead scroll the screen up. 1003instead scroll the screen up.
961 1004
962=item B<hold>: I<bool> 1005=item B<hold>: I<boolean>
963 1006
964Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1007Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
965will not immediately destroy its window when the program executed within 1008will not immediately destroy its window when the program executed within
966it exits. Instead, it will wait till it is being killed or closed by the 1009it exits. Instead, it will wait till it is being killed or closed by the
967user. 1010user.
… …
990 1033
991I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1034I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
992C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1035C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
993C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1036C<\000>: octal number) or verbatim control characters (C<^?>: delete,
994C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1037C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
995can start or end with whitespace. 1038can start or end with whitespace. B<This feature is deprecated and will
1039be removed>.
996 1040
997Please note that you need to double the C<\> when using 1041Please note that you need to double the C<\> in resource files, as
998C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1042Xlib itself does its own de-escaping (you can use C<\033> instead of
999use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1043C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1000@@RXVT_NAME@@'s own processing). 1044processing).
1001 1045
1002You can define a range of keysyms in one shot by providing a I<string> 1046You can define a range of keysyms in one shot by providing a I<string>
1003with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1047with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1004should be a character not used by the strings. 1048should be a character not used by the strings.
1005 1049
1006Its usage can be demonstrated by an example: 1050Its usage can be demonstrated by an example:
1007 1051
1008 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1052 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
1017is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1061is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1018example the following means "change the current locale to C<zh_CN.GBK> 1062example the following means "change the current locale to C<zh_CN.GBK>
1019when Control-Meta-c is being pressed": 1063when Control-Meta-c is being pressed":
1020 1064
1021 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1065 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1066
1067If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1068is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1069manpage. For example, the F<selection> extension (activated via
1070C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1071
1072 URxvt.keysym.M-C-c: perl:selection:rot13
1022 1073
1023Due the the large number of modifier combinations, a defined key mapping 1074Due the the large number of modifier combinations, a defined key mapping
1024will match if at I<at least> the specified identifiers are being set, and 1075will match if at I<at least> the specified identifiers are being set, and
1025no other key mappings with those and more bits are being defined. That 1076no other key mappings with those and more bits are being defined. That
1026means that defining a key map for C<a> will automatically provide 1077means that defining a key map for C<a> will automatically provide
… …
1050info): 1101info):
1051 1102
1052 URxvt.keysym.M-C-3: command:\033[8;25;80t 1103 URxvt.keysym.M-C-3: command:\033[8;25;80t
1053 URxvt.keysym.M-C-4: command:\033[8;48;110t 1104 URxvt.keysym.M-C-4: command:\033[8;48;110t
1054 1105
1106=item B<perl-ext-common>: I<string>
1107
1108=item B<perl-ext>: I<string>
1109
1110Comma-separated list(s) of perl extension scripts (default: C<default>) to
1111use in this terminal instance; option B<-pe>.
1112
1113Extension names can be prefixed with a C<-> sign to prohibit using
1114them. This can be useful to selectively disable some extensions loaded
1115by default, or specified via the C<perl-ext-common> resource. For
1116example, C<default,-selection> will use all the default extension except
1117C<selection>.
1118
1119Extension names can also be followed by an argument in angle brackets
1120(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1121searchable scrollback to Alt/Meta-s). Mentioning the same extension
1122multiple times with different arguments will pass multiple arguments to
1123the extension.
1124
1125Each extension is looked up in the library directories, loaded if
1126necessary, and bound to the current terminal instance.
1127
1128If both of these resources are the empty string, then the perl
1129interpreter will not be initialized. The idea behind two options is that
1130B<perl-ext-common> will be used for extensions that should be available to
1131all instances, while B<perl-ext> is used for specific instances.
1132
1133=item B<perl-eval>: I<string>
1134
1135Perl code to be evaluated when all extensions have been registered. See
1136the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1137will be ignored when running setuid/setgid.
1138
1139=item B<perl-lib>: I<path>
1140
1141Colon-separated list of additional directories that hold extension
1142scripts. When looking for extensions specified by the C<perl> resource,
1143@@RXVT_NAME@@ will first look in these directories and then in
1144F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1145will be ignored when running setuid/setgid.
1146
1147See the @@RXVT_NAME@@perl(3) manpage.
1148
1149=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1150
1151Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1152details.
1153
1154=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1155
1156Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1157for details.
1158
1159=item B<searchable-scrollback:> I<keysym>
1160
1161Sets the hotkey that starts the incremental scrollback buffer search
1162(default: C<M-s>).
1163
1164=item B<urlLauncher>: I<string>
1165
1166Specifies the program to be started with a URL argument. Used by the
1167C<selection-popup> and C<matcher> perl extensions.
1168
1169=item B<transient-for>: I<windowid>
1170
1171Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1172
1173=item B<override-redirect>: I<boolean>
1174
1175Compile I<frills>: Sets override-redirect for the terminal window, making
1176it almost invisible to window managers; option B<-override-redirect>.
1177
1055=back 1178=back
1056 1179
1057=head1 THE SCROLLBAR 1180=head1 THE SCROLLBAR
1058 1181
1059Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1182Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1077application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1200application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1078(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1201(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1079up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1202up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1080respectively. 1203respectively.
1081 1204
1082=head1 TEXT SELECTION AND INSERTION 1205=head1 THE SELECTION: SELECTING AND PASTING TEXT
1083 1206
1084The behaviour of text selection and insertion mechanism is similar to 1207The behaviour of text selection and insertion/pasting mechanism is similar
1085I<xterm>(1). 1208to I<xterm>(1).
1086 1209
1087=over 4 1210=over 4
1088 1211
1089=item B<Selection>: 1212=item B<Selecting>:
1090 1213
1091Left click at the beginning of the region, drag to the end of the region 1214Left click at the beginning of the region, drag to the end of the region
1092and release; Right click to extend the marked region; Left double-click 1215and release; Right click to extend the marked region; Left double-click
1093to select a word; Left triple-click to select the entire logical line 1216to select a word; Left triple-click to select the entire logical line
1094(which can span multiple screen lines), unless modified by resource 1217(which can span multiple screen lines), unless modified by resource
… …
1098(Compile: I<frills>) will create a rectangular selection instead of a 1221(Compile: I<frills>) will create a rectangular selection instead of a
1099normal one. In this mode, every selected row becomes its own line in the 1222normal one. In this mode, every selected row becomes its own line in the
1100selection, and trailing whitespace is visually underlined and removed from 1223selection, and trailing whitespace is visually underlined and removed from
1101the selection. 1224the selection.
1102 1225
1103=item B<Insertion>: 1226=item B<Pasting>:
1104 1227
1105Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1228Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1106an B<@@RXVT_NAME@@> window causes the current text selection to be 1229window causes the value of the PRIMARY selection (or CLIPBOARD with the
1107inserted as if it had been typed on the keyboard. 1230B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1231
1232Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1233inserted too.
1108 1234
1109=back 1235=back
1110 1236
1111=head1 CHANGING FONTS 1237=head1 CHANGING FONTS
1112 1238
1113Changing fonts (or font sizes, respectively) via the keypad is not yet 1239Changing fonts (or font sizes, respectively) via the keypad is not yet
1114supported in rxvt-unicode. Bug me if you need this. 1240supported in rxvt-unicode. Bug me if you need this.
1115 1241
1116You can, however, switch fonts at runtime using escape sequences (and 1242You can, however, switch fonts at runtime using escape sequences, e.g.:
1117therefore using the menubar), e.g.:
1118 1243
1119 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1244 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1245
1246You can use keyboard shortcuts, too:
1247
1248 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1249 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1120 1250
1121rxvt-unicode will automatically re-apply these fonts to the output so far. 1251rxvt-unicode will automatically re-apply these fonts to the output so far.
1122 1252
1123=head1 ISO 14755 SUPPORT 1253=head1 ISO 14755 SUPPORT
1124 1254
… …
1152This mode lets you input characters representing the keycap symbols of 1282This mode lets you input characters representing the keycap symbols of
1153your keyboard, if representable in the current locale encoding. 1283your keyboard, if representable in the current locale encoding.
1154 1284
1155Start by pressing C<Control> and C<Shift> together, then releasing 1285Start by pressing C<Control> and C<Shift> together, then releasing
1156them. The next special key (cursor keys, home etc.) you enter will not 1286them. The next special key (cursor keys, home etc.) you enter will not
1157invoke it's usual function but instead will insert the corresponding 1287invoke its usual function but instead will insert the corresponding
1158keycap symbol. The symbol will only be entered when the key has been 1288keycap symbol. The symbol will only be entered when the key has been
1159released, otherwise pressing e.g. C<Shift> would enter the symbol for 1289released, otherwise pressing e.g. C<Shift> would enter the symbol for
1160C<ISO Level 2 Switch>, although your intention might have been to enter a 1290C<ISO Level 2 Switch>, although your intention might have been to enter a
1161reverse tab (Shift-Tab). 1291reverse tab (Shift-Tab).
1162 1292
… …
1195=head1 COLORS AND GRAPHICS 1325=head1 COLORS AND GRAPHICS
1196 1326
1197In addition to the default foreground and background colours, 1327In addition to the default foreground and background colours,
1198B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1328B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1199high-intensity bold/blink versions of the same). Here is a list of the 1329high-intensity bold/blink versions of the same). Here is a list of the
1200colours with their B<rgb.txt> names. 1330colours with their names.
1201 1331
1202=begin table 1332=begin table
1203 1333
1204 B<color0> (black) = Black 1334 B<color0> (black) = Black
1205 B<color1> (red) = Red3 1335 B<color1> (red) = Red3
… …
1225It is also possible to specify the colour values of B<foreground>, 1355It is also possible to specify the colour values of B<foreground>,
1226B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1356B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1227a number 0-15, as a convenient shorthand to reference the colour name of 1357a number 0-15, as a convenient shorthand to reference the colour name of
1228color0-color15. 1358color0-color15.
1229 1359
1360In addition to the colours defined above, @@RXVT_NAME@@ offers an
1361additional 72 colours. The first 64 of those (with indices 16 to 79)
1362consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
136316>), followed by 8 additional shades of gray (with indices 80 to 87).
1364
1365Together, all those colours implement the 88 colour xterm colours. Only
1366the first 16 can be changed using resources currently, the rest can only
1367be changed via command sequences ("escape codes").
1368
1230Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1369Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1231always swapping the foreground/background colours. This is in contrast to 1370always swapping the foreground/background colours. This is in contrast to
1232I<xterm>(1) where the colours are only swapped if they have not otherwise 1371I<xterm>(1) where the colours are only swapped if they have not otherwise
1233been specified. For example, 1372been specified. For example,
1234 1373
… …
1239would yield White on Black, while on I<xterm>(1) it would yield Black 1378would yield White on Black, while on I<xterm>(1) it would yield Black
1240on White. 1379on White.
1241 1380
1242=back 1381=back
1243 1382
1383=head2 ALPHA CHANNEL SUPPORT
1384
1385If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1386their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1387(recommended, but B<MUST> have 4 digits/component) colour specifications,
1388in addition to the ones provided by X, where the additional A component
1389specifies opacity (alpha) values. The minimum value of C<0> is completely
1390transparent). You can also prefix any color with C<[percent]>, where
1391C<percent> is a decimal percentage (0-100) that specifies the opacity of
1392the color, where C<0> is completely transparent and C<100> is completelxy
1393opaque.
1394
1395You probably need to specify B<"-depth 32">, too, and have the luck that
1396your X-server uses ARGB pixel layout, as X is far from just supporting
1397ARGB visuals out of the box, and rxvt-unicode just fudges around.
1398
1399For example, the following selects an almost completely transparent red
1400background, and an almost opaque pink foreground:
1401
1402 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1403
1404I<Please note that transparency of any kind if completely unsupported by
1405the author. Don't bug him with installation questions!>
1406
1244=head1 ENVIRONMENT 1407=head1 ENVIRONMENT
1245 1408
1246B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1409B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1247 1410
1248=over 4 1411=over 4
1249 1412
1250=item B<TERM> 1413=item B<TERM>
1251 1414
1252Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1415Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1253resources or on the commandline. 1416resources or on the command line.
1254 1417
1255=item B<COLORTERM> 1418=item B<COLORTERM>
1256 1419
1257Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1420Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1258compiled with XPM support, and optionally with the added extension 1421compiled with XPM support, and optionally with the added extension
1259C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1422C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1260 1423
1261=item B<COLORFGBG> 1424=item B<COLORFGBG>
1262 1425
… …
1280C<--with-terminfo=PATH>. 1443C<--with-terminfo=PATH>.
1281 1444
1282=item B<DISPLAY> 1445=item B<DISPLAY>
1283 1446
1284Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1447Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1285display in it's child processes. 1448display in its child processes.
1286 1449
1287=item B<SHELL> 1450=item B<SHELL>
1288 1451
1289The shell to be used for command execution, defaults to C</bin/sh>. 1452The shell to be used for command execution, defaults to C</bin/sh>.
1290
1291=item B<RXVTPATH>
1292
1293The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1294files.
1295
1296=item B<PATH>
1297
1298Used in the same way as C<RXVTPATH>.
1299 1453
1300=item B<RXVT_SOCKET> 1454=item B<RXVT_SOCKET>
1301 1455
1302The unix domain socket path used by @@RXVT_NAME@@c(1) and 1456The unix domain socket path used by @@RXVT_NAME@@c(1) and
1303@@RXVT_NAME@@d(1). 1457@@RXVT_NAME@@d(1).
… …
1341 1495
1342=item Project Coordinator 1496=item Project Coordinator
1343 1497
1344Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1498Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1345 1499
1346L<http://software.schmorp.de/#rxvt-unicode> 1500L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1347 1501
1348=back 1502=back
1349 1503
1350=head1 AUTHORS 1504=head1 AUTHORS
1351 1505
… …
1373 1527
1374Project Coordinator (changes.txt 2.21a to 2.4.5) 1528Project Coordinator (changes.txt 2.21a to 2.4.5)
1375 1529
1376=item Geoff Wing L<< <gcw@pobox.com> >> 1530=item Geoff Wing L<< <gcw@pobox.com> >>
1377 1531
1378Rewrote screen display and text selection routines. Project Coordinator 1532Rewrote screen display and text selection routines.
1533
1379(changes.txt 2.4.6 - rxvt-unicode) 1534Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1380 1535
1381=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1536=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1382 1537
1383Forked rxvt-unicode, rewrote most of the display code and internal 1538Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1384character handling to store text in unicode, improve xterm 1539extension, random hacks, numerous bugfixes and extensions.
1385compatibility and apply numerous other bugfixes and extensions.
1386 1540
1387Project Coordinator (Changes 1.0 -) 1541Project Coordinator (Changes 1.0 -)
1388 1542
1543=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1544
1545Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1546
1389=back 1547=back
1390 1548

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines