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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines