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.62 by root, Sun Apr 17 22:36:13 2005 UTC vs.
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC

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>.
114 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@@)!>
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. resource B<fading>. 126Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade
128colour; resource B<fading>.
129
130=item B<-fadecolor> I<colour>
131
132Fade to this colour when fading is used (see B<-fade>). The default colour
133is opaque black. resource B<fadeColor>.
118 134
119=item B<-tint> I<colour> 135=item B<-tint> I<colour>
120 136
121Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
122transparency 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
123option 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
124tinting it. 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
125 144
126=item B<-sh> 145=item B<-sh>
127 146
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background 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
162resource B<borderColor>. 181resource B<borderColor>.
163 182
164=item B<-fn> I<fontlist> 183=item B<-fn> I<fontlist>
165 184
166Select 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
167that are used in turn when trying to display Unicode characters. The 186that are checked in order when trying to find glyphs for characters. The
168first font defines the cell size for characters; other fonts might be 187first font defines the cell size for characters; other fonts might be
169smaller, but not (in general) larger. A (hopefully) reasonable default 188smaller, but not (in general) larger. A (hopefully) reasonable default
170font 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.
171 190
172In 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
173with 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:>,
174e.g.: 193e.g.:
175 194
176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 195 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 196 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
179See 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
180section of @@RXVT_NAME@@(7). 199section of @@RXVT_NAME@@(7).
181 200
182=item B<-fb> I<fontlist> 201=item B<-fb> I<fontlist>
183 202
184Compile 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
185be printed. See resource B<boldFont> for details. 204are to be printed. See resource B<boldFont> for details.
186 205
187=item B<-fi> I<fontlist> 206=item B<-fi> I<fontlist>
188 207
189Compile 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>
190be printed. See resource B<italicFont> for details. 209characters are to be printed. See resource B<italicFont> for details.
191 210
192=item B<-fbi> I<fontlist> 211=item B<-fbi> I<fontlist>
193 212
194Compile 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
195be 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.
196 222
197=item B<-name> I<name> 223=item B<-name> I<name>
198 224
199Specify the application name under which resources are to be obtained, 225Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 226rather than the default executable file name. Name should not contain
238 264
239Put scrollbar on right/left; resource B<scrollBar_right>. 265Put scrollbar on right/left; resource B<scrollBar_right>.
240 266
241=item B<-st>|B<+st> 267=item B<-st>|B<+st>
242 268
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 270resource B<scrollBar_floating>.
245 271
246=item B<-ptab>|B<+ptab> 272=item B<-ptab>|B<+ptab>
247 273
248If enabled (default), "Horizontal Tab" characters are being stored as 274If enabled (default), "Horizontal Tab" characters are being stored as
279=item B<-bl> 305=item B<-bl>
280 306
281Compile 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.
282if 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
283decorations; 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>.
284 322
285=item B<-lsp> I<number> 323=item B<-lsp> I<number>
286 324
287Compile I<frills>: Lines (pixel height) to insert between each row of 325Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 326the display. Useful to work around font rendering problems; resource
303given 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
304on 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
305run the program specified by the B<SHELL> environment variable or, 343run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 344failing that, I<sh(1)>.
307 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
308=item B<-title> I<text> 351=item B<-title> I<text>
309 352
310Window title (B<-T> still respected); the default title is the basename 353Window title (B<-T> still respected); the default title is the basename
311of 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
312application name; resource B<title>. 355application name; resource B<title>.
368=item B<-ssr>|B<+ssr> 411=item B<-ssr>|B<+ssr>
369 412
370Turn on/off secondary screen scroll (default enabled); resource 413Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 414B<secondaryScroll>.
372 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
373=item B<-keysym.>I<sym> I<string> 423=item B<-keysym.>I<sym> I<string>
374 424
375Remap a key symbol. See resource B<keysym>. 425Remap a key symbol. See resource B<keysym>.
376 426
377=item B<-embed> I<windowid> 427=item B<-embed> I<windowid>
378 428
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 429Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380which enables applications to easily embed a terminal. 430which enables applications to easily embed a terminal.
381 431
382Right 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
383shouldn'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
384quite 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
387The window will not be destroyed when @@RXVT_NAME@@ exits. 437The window will not be destroyed when @@RXVT_NAME@@ exits.
388 438
389It 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
390descriptors 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
391can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
392terminal. 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
393not. 443not.
394 444
395Here 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
396used (a longer example is in F<doc/embed>): 446used (a longer example is in F<doc/embed>):
397 447
399 $rxvt->signal_connect_after (realize => sub { 449 $rxvt->signal_connect_after (realize => sub {
400 my $xid = $_[0]->window->get_xid; 450 my $xid = $_[0]->window->get_xid;
401 system "@@RXVT_NAME@@ -embed $xid &"; 451 system "@@RXVT_NAME@@ -embed $xid &";
402 }); 452 });
403 453
404=item B<-pty-fd> I<fileno> 454=item B<-pty-fd> I<file descriptor>
405 455
406Tells @@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
407pair 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
408useful 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
409without having to run a program within it. 459without having to run a program within it.
410 460
411If 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
412entries 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
413yourself if you want that. 463yourself if you want that.
464
465As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations.
414 467
415Here 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
416longer example is in F<doc/pty-fd>): 469longer example is in F<doc/pty-fd>):
417 470
418 use IO::Pty; 471 use IO::Pty;
425 478
426 # now communicate with rxvt 479 # now communicate with rxvt
427 my $slave = $pty->slave; 480 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" } 481 while (<$slave>) { print $slave "got <$_>\n" }
429 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
430=back 488=back
431 489
432=head1 RESOURCES (available also as long-options) 490=head1 RESOURCES (available also as long-options)
433 491
434Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
435options) compiled into your version. 493options) compiled into your version.
436 494
437There 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
438Xresource data: using the X libraries (Xrm*-functions) or internal 496distribution do also load settings from the B<~/.Xresources> file when X
439Xresources reader (B<~/.Xdefaults>). For the first method (ie. 497starts. @@RXVT_NAME@@ will consult the following files/resources in order,
440B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 498with later settings overwriting earlier ones:
441resources using X11 tools like B<xrdb>. Many distribution do also load
442settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
443will consult the following files/resources in order, with later settings
444overwriting earlier ones:
445 499
446 1. system-wide app-defaults file, either locale-dependent OR global 500 1. system-wide app-defaults file, either locale-dependent OR global
447 2. app-defaults file in $XAPPLRESDIR 501 2. app-defaults file in $XAPPLRESDIR
448 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
449 4. SCREEN_RESOURCES for the current screen 503 4. SCREEN_RESOURCES for the current screen
450 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
451 505
452If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
453lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
454set in XAPPLOADDIR/URxvt (compile-time defined: usually
455B</usr/lib/X11/app-defaults/URxvt>) and resources set in
456B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
457Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
458class 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
459resources 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
460easily configured, while the class name B<URxvt> allows resources 509configured, while the class name B<URxvt> allows resources unique to
461unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 510B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
462shared between different B<@@RXVT_NAME@@> configurations. If no 511configurations. If no resources are specified, suitable defaults will
463resources are specified, suitable defaults will be used. Command-line 512be used. Command-line arguments can be used to override resource
464arguments can be used to override resource settings. The following 513settings. The following resources are supported (you might want to
465resources are allowed: 514check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
515extensions not documented here):
466 516
467=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>.
468 523
469=item B<geometry:> I<geom> 524=item B<geometry:> I<geom>
470 525
471Create the window with the specified X window geometry [default 80x24]; 526Create the window with the specified X window geometry [default 80x24];
472option B<-geometry>. 527option B<-geometry>.
546 601
547B<True>: make the background inherit the parent windows' pixmap, giving 602B<True>: make the background inherit the parent windows' pixmap, giving
548artificial transparency. B<False>: do not inherit the parent windows' 603artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 604pixmap.
550 605
606I<Please note that transparency of any kind if completely unsupported by
607the author. Don't bug him with installation questions!>
608
551=item B<fading:> I<number> 609=item B<fading:> I<number>
552 610
553Fade the text by the given percentage when focus is lost. 611Fade the text by the given percentage when focus is lost; option B<-fade>.
612
613=item B<fadeColor:> I<colour>
614
615Fade to this colour, when fading is used (see B<fading:>). The default
616colour is black; option B<-fadecolor>.
554 617
555=item B<tintColor:> I<colour> 618=item B<tintColor:> I<colour>
556 619
557Tint the transparent background pixmap with the given colour. 620Tint the transparent background pixmap with the given colour; option
621B<-tint>.
558 622
559=item B<shading:> I<number> 623=item B<shading:> I<number>
560 624
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 626image in addition to tinting it.
566Use the specified colour for the scrollbar [default #B2B2B2]. 630Use the specified colour for the scrollbar [default #B2B2B2].
567 631
568=item B<troughColor:> I<colour> 632=item B<troughColor:> I<colour>
569 633
570Use the specified colour for the scrollbar's trough area [default 634Use the specified colour for the scrollbar's trough area [default
571#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 635#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572 636
573=item B<borderColor:> I<colour> 637=item B<borderColor:> I<colour>
574 638
575The colour of the border around the text area and between the scrollbar 639The colour of the border around the text area and between the scrollbar
576and the text. 640and the text.
585of 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
586specifies an integer number of images in that direction. No image will 650specifies an integer number of images in that direction. No image will
587be magnified beyond 10 times its original size. The maximum permitted 651be magnified beyond 10 times its original size. The maximum permitted
588scale is 1000. [default 0x0+50+50] 652scale is 1000. [default 0x0+50+50]
589 653
590=item B<menu:> I<file[;tag]>
591
592Read in the specified menu file (note the `.menu' extension is
593optional) and also optionally specify a starting tag to find. See the
594reference documentation for details on the syntax for the menuBar.
595
596=item B<path:> I<path> 654=item B<path:> I<path>
597 655
598Specify the colon-delimited search path for finding files (XPM and 656Specify the colon-delimited search path for finding XPM files.
599menus), in addition to the paths specified by the B<RXVTPATH> and
600B<PATH> environment variables.
601 657
602=item B<font:> I<fontlist> 658=item B<font:> I<fontlist>
603 659
604Select 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
605names that are used in turn when trying to display Unicode characters. 661that are checked in order when trying to find glyphs for characters. The
606The first font defines the cell size for characters; other fonts might 662first font defines the cell size for characters; other fonts might be
607be smaller, but not larger. A reasonable default font list is always 663smaller, but not (in general) larger. A (hopefully) reasonable default
608appended to it. option B<-fn>. 664font list is always appended to it; option B<-fn>.
609 665
610Each 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
611optional 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:>.
612 668
613In addition, each font can be prefixed with additional hints and 669In addition, each font can be prefixed with additional hints and
615hint 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
616fonts. 672fonts.
617 673
618For example, this font resource 674For example, this font resource
619 675
620 URxvt*font: 9x15bold,\ 676 URxvt.font: 9x15bold,\
621 -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,\
622 -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, \
623 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 679 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
624 xft:Code2000:antialias=false 680 xft:Code2000:antialias=false
625 681
659not possible, replacement fonts of the desired shape will be tried. 715not possible, replacement fonts of the desired shape will be tried.
660 716
661If 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
662text font will being used for the given style. 718text font will being used for the given style.
663 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
664=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
665 729
666Set 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
667xterm 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
668xterm style selection. 732xterm style selection.
669 733
670=item B<scrollstyle:> I<mode> 734=item B<scrollstyle:> I<mode>
671 735
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.. 737the author's favourite.
674 738
675=item B<title:> I<string> 739=item B<title:> I<string>
676 740
677Set window title string, the default title is the command-line 741Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 742specified after the B<-e> option, if any, otherwise the application
710 774
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 775Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
712B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 776B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 777B<Shift-Print> to include the scrollback as well.
714 778
779The string will be interpreted as if typed into the shell as-is.
780
781Example:
782
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784
785This creates a new file in your home directory with the screen contents
786every time you hit C<Print>.
787
715=item B<scrollBar:> I<boolean> 788=item B<scrollBar:> I<boolean>
716 789
717B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718disable the scrollbar; option B<+sb>. 791disable the scrollbar; option B<+sb>.
719 792
740 813
741=item B<scrollWithBuffer:> I<boolean> 814=item B<scrollWithBuffer:> I<boolean>
742 815
743B<True>: scroll with scrollback buffer when tty receives new lines (and 816B<True>: scroll with scrollback buffer when tty receives new lines (and
744B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
745with scrollback buffer when tty recieves new lines; option B<+sw>. 818with scrollback buffer when tty receives new lines; option B<+sw>.
746 819
747=item B<scrollTtyKeypress:> I<boolean> 820=item B<scrollTtyKeypress:> I<boolean>
748 821
749B<True>: scroll to bottom when a non-special key is pressed. Special keys 822B<True>: scroll to bottom when a non-special key is pressed. Special keys
750are those which are intercepted by rxvt-unicode for special handling and 823are those which are intercepted by rxvt-unicode for special handling and
769=item B<borderLess:> I<boolean> 842=item B<borderLess:> I<boolean>
770 843
771Set MWM hints to request a borderless window, i.e. if honoured by the 844Set MWM hints to request a borderless window, i.e. if honoured by the
772WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 845WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
773 846
847=item B<skipBuiltinGlyphs:> I<boolean>
848
849Compile I<frills>: Disable the usage of the built-in block graphics/line
850drawing characters and just rely on what the specified fonts provide. Use
851this if you have a good font and want to use its block graphic glyphs;
852option B<-sbg>.
853
774=item B<termName:> I<termname> 854=item B<termName:> I<termname>
775 855
776Specifies the terminal type name to be set in the B<TERM> environment 856Specifies the terminal type name to be set in the B<TERM> environment
777variable; option B<-tn>. 857variable; option B<-tn>.
778 858
833pressed. If unset it will send the sequence traditionally associated 913pressed. If unset it will send the sequence traditionally associated
834with the B<Execute> key. 914with the B<Execute> key.
835 915
836=item B<cutchars:> I<string> 916=item B<cutchars:> I<string>
837 917
838The characters used as delimiters for double-click word selection. The 918The characters used as delimiters for double-click word selection
839built-in default: 919(whitespace delimiting is added automatically if resource is given).
920
921When the selection extension is in use (the default if compiled in, see
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
923will be created (if the resource exists, otherwise, no regex will be
924created). In this mode, characters outside ISO-8859-1 can be used.
925
926When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used:
840 928
841B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
842 930
843=item B<preeditType:> I<style> 931=item B<preeditType:> I<style>
844 932
851=item B<imLocale:> I<name> 939=item B<imLocale:> I<name>
852 940
853The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 941The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
854C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 942C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
855input extension to be able to input japanese characters while staying in 943input extension to be able to input japanese characters while staying in
856another locale. option B<-imlocale>. 944another locale; option B<-imlocale>.
857 945
858=item B<imFont:> I<fontset> 946=item B<imFont:> I<fontset>
859 947
860Specify the font-set used for XIM styles C<OverTheSpot> or 948Specify the font-set used for XIM styles C<OverTheSpot> or
861C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 949C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
866 954
867=item B<tripleclickwords:> I<boolean> 955=item B<tripleclickwords:> I<boolean>
868 956
869Change the meaning of triple-click selection with the left mouse 957Change the meaning of triple-click selection with the left mouse
870button. Instead of selecting a full line it will extend the selection to 958button. Instead of selecting a full line it will extend the selection to
871the end of the logical line only. option B<-tcw>. 959the end of the logical line only; option B<-tcw>.
872 960
873=item B<insecure:> I<boolean> 961=item B<insecure:> I<boolean>
874 962
875Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 963Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876echo arbitrary strings like the icon name or the locale. This could be 964echo arbitrary strings like the icon name or the locale. This could be
877abused if somebody gets 8-bit-clean access to your display, whether 965abused if somebody gets 8-bit-clean access to your display, whether
878throuh a mail client displaying mail bodies unfiltered or though 966through a mail client displaying mail bodies unfiltered or through
879write(1). Therefore, these sequences are disabled by default. (Note 967write(1) or any other means. Therefore, these sequences are disabled by
880that other terminals, including xterm, have these sequences 968default. (Note that many other terminals, including xterm, have these
881enabled by default). You can enable them by setting this boolean 969sequences enabled by default, which doesn't make it safer, though).
882resource or specifying B<-insecure> as an option. At the moment, this 970
883enabled display-answer, locale, findfont, icon label and window title 971You can enable them by setting this boolean resource or specifying
884requests as well as dynamic menubar dispatch. 972B<-insecure> as an option. At the moment, this enables display-answer,
973locale, findfont, icon label and window title requests.
885 974
886=item B<modifier:> I<modifier> 975=item B<modifier:> I<modifier>
887 976
888Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 977Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
889B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 978B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
893 982
894Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 983Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
895character is passed through. It may contain escape values as described 984character is passed through. It may contain escape values as described
896in the entry on B<keysym> following. 985in the entry on B<keysym> following.
897 986
898=item B<secondaryScreen:> I<bool> 987=item B<secondaryScreen:> I<boolean>
899 988
900Turn on/off secondary screen (default enabled). 989Turn on/off secondary screen (default enabled).
901 990
902=item B<secondaryScroll:> I<bool> 991=item B<secondaryScroll:> I<boolean>
903 992
904Turn on/off secondary screen scroll (default enabled). If the this 993Turn on/off secondary screen scroll (default enabled). If the this
905option is enabled, scrolls on the secondary screen will change the 994option is enabled, scrolls on the secondary screen will change the
906scrollback buffer and switching to/from the secondary screen will 995scrollback buffer and switching to/from the secondary screen will
907instead scroll the screen up. 996instead scroll the screen up.
997
998=item B<hold>: I<boolean>
999
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the
1003user.
908 1004
909=item B<keysym.>I<sym>: I<string> 1005=item B<keysym.>I<sym>: I<string>
910 1006
911Compile I<frills>: Associate I<string> with keysym I<sym>. The 1007Compile I<frills>: Associate I<string> with keysym I<sym>. The
912intervening resource name B<keysym.> cannot be omitted. 1008intervening resource name B<keysym.> cannot be omitted.
932C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
933C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
934C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
935can start or end with whitespace. 1031can start or end with whitespace.
936 1032
937Please note that you need to double the C<\> when using 1033Please note that you need to double the C<\> in resource files, as
938C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1034Xlib itself does its own de-escaping (you can use C<\033> instead of
939use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
940@@RXVT_NAME@@'s own processing). 1036processing).
941 1037
942You can define a range of keysyms in one shot by providing a I<string> 1038You can define a range of keysyms in one shot by providing a I<string>
943with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
944should be a character not used by the strings. 1040should be a character not used by the strings.
945 1041
946Its usage can be demonstrated by an example: 1042Its usage can be demonstrated by an example:
947 1043
948 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1044 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
958example the following means "change the current locale to C<zh_CN.GBK> 1054example the following means "change the current locale to C<zh_CN.GBK>
959when Control-Meta-c is being pressed": 1055when Control-Meta-c is being pressed":
960 1056
961 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1057 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
962 1058
1059If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1060is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1061manpage. For example, the F<selection> extension (activated via
1062C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063
1064 URxvt.keysym.M-C-c: perl:selection:rot13
1065
1066Due the the large number of modifier combinations, a defined key mapping
1067will match if at I<at least> the specified identifiers are being set, and
1068no other key mappings with those and more bits are being defined. That
1069means that defining a key map for C<a> will automatically provide
1070definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071mappings themselves.
1072
1073Unfortunately, this will override built-in key mappings. For example
1074if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1075C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1076user-defined keymap using the C<builtin:> replacement:
1077
1078 URxvt.keysym.Insert: <my insert key sequence>
1079 URxvt.keysym.S-Insert: builtin:
1080
1081The first line defines a mapping for C<Insert> and I<any> combination
1082of modifiers. The second line re-establishes the default mapping for
1083C<Shift-Insert>.
1084
963The following example will map Control-Meta-1 and Control-Meta-2 to 1085The following example will map Control-Meta-1 and Control-Meta-2 to
964the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1086the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
965font-switching at runtime: 1087font-switching at runtime:
966 1088
967 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1089 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
970Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1092Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
971info): 1093info):
972 1094
973 URxvt.keysym.M-C-3: command:\033[8;25;80t 1095 URxvt.keysym.M-C-3: command:\033[8;25;80t
974 URxvt.keysym.M-C-4: command:\033[8;48;110t 1096 URxvt.keysym.M-C-4: command:\033[8;48;110t
1097
1098=item B<perl-ext-common>: I<string>
1099
1100=item B<perl-ext>: I<string>
1101
1102Comma-separated list(s) of perl extension scripts (default: C<default>) to
1103use in this terminal instance; option B<-pe>.
1104
1105Extension names can be prefixed with a C<-> sign to prohibit using
1106them. This can be useful to selectively disable some extensions loaded
1107by default, or specified via the C<perl-ext-common> resource. For
1108example, C<default,-selection> will use all the default extension except
1109C<selection>.
1110
1111Extension names can also be followed by an argument in angle brackets
1112(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1113searchable scrollback to Alt/Meta-s). Mentioning the same extension
1114multiple times with different arguments will pass multiple arguments to
1115the extension.
1116
1117Each extension is looked up in the library directories, loaded if
1118necessary, and bound to the current terminal instance.
1119
1120If both of these resources are the empty string, then the perl
1121interpreter will not be initialized. The idea behind two options is that
1122B<perl-ext-common> will be used for extensions that should be available to
1123all instances, while B<perl-ext> is used for specific instances.
1124
1125=item B<perl-eval>: I<string>
1126
1127Perl code to be evaluated when all extensions have been registered. See
1128the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1129will be ignored when running setuid/setgid.
1130
1131=item B<perl-lib>: I<path>
1132
1133Colon-separated list of additional directories that hold extension
1134scripts. When looking for extensions specified by the C<perl> resource,
1135@@RXVT_NAME@@ will first look in these directories and then in
1136F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1137will be ignored when running setuid/setgid.
1138
1139See the @@RXVT_NAME@@perl(3) manpage.
1140
1141=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142
1143Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1144details.
1145
1146=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1147
1148Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1149for details.
1150
1151=item B<searchable-scrollback:> I<keysym>
1152
1153Sets the hotkey that starts the incremental scrollback buffer search
1154(default: C<M-s>).
1155
1156=item B<urlLauncher>: I<string>
1157
1158Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions.
1160
1161=item B<transient-for>: I<windowid>
1162
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164
1165=item B<override-redirect>: I<boolean>
1166
1167Compile I<frills>: Sets override-redirect for the terminal window, making
1168it almost invisible to window managers; option B<-override-redirect>.
975 1169
976=back 1170=back
977 1171
978=head1 THE SCROLLBAR 1172=head1 THE SCROLLBAR
979 1173
1014to select a word; Left triple-click to select the entire logical line 1208to select a word; Left triple-click to select the entire logical line
1015(which can span multiple screen lines), unless modified by resource 1209(which can span multiple screen lines), unless modified by resource
1016B<tripleclickwords>. 1210B<tripleclickwords>.
1017 1211
1018Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1212Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1019(Compile: I<frills>) will create a rectangular selection instead of a normal 1213(Compile: I<frills>) will create a rectangular selection instead of a
1020one. 1214normal one. In this mode, every selected row becomes its own line in the
1215selection, and trailing whitespace is visually underlined and removed from
1216the selection.
1021 1217
1022=item B<Insertion>: 1218=item B<Insertion>:
1023 1219
1024Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1025an B<@@RXVT_NAME@@> window causes the current text selection to be 1221window causes the value of the PRIMARY selection (or CLIPBOARD with the
1026inserted as if it had been typed on the keyboard. 1222Meta modifier) to be inserted as if it had been typed on the keyboard.
1223
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too.
1027 1226
1028=back 1227=back
1029 1228
1030=head1 CHANGING FONTS 1229=head1 CHANGING FONTS
1031 1230
1032Changing fonts (or font sizes, respectively) via the keypad is not yet 1231Changing fonts (or font sizes, respectively) via the keypad is not yet
1033supported in rxvt-unicode. Bug me if you need this. 1232supported in rxvt-unicode. Bug me if you need this.
1034 1233
1035You can, however, switch fonts at runtime using escape sequences (and 1234You can, however, switch fonts at runtime using escape sequences, e.g.:
1036therefore using the menubar), e.g.:
1037 1235
1038 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1236 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1237
1238You can use keyboard shortcuts, too:
1239
1240 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1241 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1039 1242
1040rxvt-unicode will automatically re-apply these fonts to the output so far. 1243rxvt-unicode will automatically re-apply these fonts to the output so far.
1041 1244
1042=head1 ISO 14755 SUPPORT 1245=head1 ISO 14755 SUPPORT
1043 1246
1071This mode lets you input characters representing the keycap symbols of 1274This mode lets you input characters representing the keycap symbols of
1072your keyboard, if representable in the current locale encoding. 1275your keyboard, if representable in the current locale encoding.
1073 1276
1074Start by pressing C<Control> and C<Shift> together, then releasing 1277Start by pressing C<Control> and C<Shift> together, then releasing
1075them. The next special key (cursor keys, home etc.) you enter will not 1278them. The next special key (cursor keys, home etc.) you enter will not
1076invoke it's usual function but instead will insert the corresponding 1279invoke its usual function but instead will insert the corresponding
1077keycap symbol. The symbol will only be entered when the key has been 1280keycap symbol. The symbol will only be entered when the key has been
1078released, otherwise pressing e.g. C<Shift> would enter the symbol for 1281released, otherwise pressing e.g. C<Shift> would enter the symbol for
1079C<ISO Level 2 Switch>, although your intention might have been to enter a 1282C<ISO Level 2 Switch>, although your intention might have been to enter a
1080reverse tab (Shift-Tab). 1283reverse tab (Shift-Tab).
1081 1284
1114=head1 COLORS AND GRAPHICS 1317=head1 COLORS AND GRAPHICS
1115 1318
1116In addition to the default foreground and background colours, 1319In addition to the default foreground and background colours,
1117B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1320B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1118high-intensity bold/blink versions of the same). Here is a list of the 1321high-intensity bold/blink versions of the same). Here is a list of the
1119colours with their B<rgb.txt> names. 1322colours with their names.
1120 1323
1121=begin table 1324=begin table
1122 1325
1123 B<color0> (black) = Black 1326 B<color0> (black) = Black
1124 B<color1> (red) = Red3 1327 B<color1> (red) = Red3
1144It is also possible to specify the colour values of B<foreground>, 1347It is also possible to specify the colour values of B<foreground>,
1145B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1348B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1146a number 0-15, as a convenient shorthand to reference the colour name of 1349a number 0-15, as a convenient shorthand to reference the colour name of
1147color0-color15. 1350color0-color15.
1148 1351
1352In addition to the colours defined above, @@RXVT_NAME@@ offers an
1353additional 72 colours. The first 64 of those (with indices 16 to 79)
1354consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135516>), followed by 8 additional shades of gray (with indices 80 to 87).
1356
1357Together, all those colours implement the 88 colour xterm colours. Only
1358the first 16 can be changed using resources currently, the rest can only
1359be changed via command sequences ("escape codes").
1360
1149Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1361Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1150always swapping the foreground/background colours. This is in contrast to 1362always swapping the foreground/background colours. This is in contrast to
1151I<xterm>(1) where the colours are only swapped if they have not otherwise 1363I<xterm>(1) where the colours are only swapped if they have not otherwise
1152been specified. For example, 1364been specified. For example,
1153 1365
1158would yield White on Black, while on I<xterm>(1) it would yield Black 1370would yield White on Black, while on I<xterm>(1) it would yield Black
1159on White. 1371on White.
1160 1372
1161=back 1373=back
1162 1374
1375=head2 ALPHA CHANNEL SUPPORT
1376
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1379(recommended, but B<MUST> have 4 digits/component) colour specifications,
1380in addition to the ones provided by X, where the additional A component
1381specifies opacity (alpha) values. The minimum value of C<0> is completely
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on
1383to four hex digits specifiying the opacity value.
1384
1385You probably need to specify B<"-depth 32">, too, and have the luck that
1386your X-server uses ARGB pixel layout, as X is far from just supporting
1387ARGB visuals out of the box, and rxvt-unicode just fudges around.
1388
1389For example, the following selects an almost completely transparent red
1390background, and an almost opaque pink foreground:
1391
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1393
1394I<Please note that transparency of any kind if completely unsupported by
1395the author. Don't bug him with installation questions!>
1396
1163=head1 ENVIRONMENT 1397=head1 ENVIRONMENT
1164 1398
1165B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1399B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1166 1400
1167=over 4 1401=over 4
1168 1402
1169=item B<TERM> 1403=item B<TERM>
1170 1404
1171Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1405Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1172resources or on the commandline. 1406resources or on the command line.
1173 1407
1174=item B<COLORTERM> 1408=item B<COLORTERM>
1175 1409
1176Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1410Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1177compiled with XPM support, and optionally with the added extension 1411compiled with XPM support, and optionally with the added extension
1178C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1179 1413
1180=item B<COLORFGBG> 1414=item B<COLORFGBG>
1181 1415
1199C<--with-terminfo=PATH>. 1433C<--with-terminfo=PATH>.
1200 1434
1201=item B<DISPLAY> 1435=item B<DISPLAY>
1202 1436
1203Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1437Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1204display in it's child processes. 1438display in its child processes.
1205 1439
1206=item B<SHELL> 1440=item B<SHELL>
1207 1441
1208The shell to be used for command execution, defaults to C</bin/sh>. 1442The shell to be used for command execution, defaults to C</bin/sh>.
1209
1210=item B<RXVTPATH>
1211
1212The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1213files.
1214
1215=item B<PATH>
1216
1217Used in the same way as C<RXVTPATH>.
1218 1443
1219=item B<RXVT_SOCKET> 1444=item B<RXVT_SOCKET>
1220 1445
1221The unix domain socket path used by @@RXVT_NAME@@c(1) and 1446The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222@@RXVT_NAME@@d(1). 1447@@RXVT_NAME@@d(1).
1223 1448
1224Default C<< $HOME/.rxvt-unicode-<nodename >>. 1449Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225 1450
1226=item B<HOME> 1451=item B<HOME>
1227 1452
1228Used to locate the default directory for the unix domain socket for 1453Used to locate the default directory for the unix domain socket for
1229daemon communications and to locate various resource files (such as 1454daemon communications and to locate various resource files (such as
1250 1475
1251=back 1476=back
1252 1477
1253=head1 SEE ALSO 1478=head1 SEE ALSO
1254 1479
1255@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1480@@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)
1256
1257=head1 BUGS
1258
1259Check the BUGS file for an up-to-date list.
1260
1261Cursor change support is not yet implemented.
1262
1263Click-and-drag doesn't work with X11 mouse report overriding.
1264 1481
1265=head1 CURRENT PROJECT COORDINATOR 1482=head1 CURRENT PROJECT COORDINATOR
1266 1483
1267=over 4 1484=over 4
1268 1485
1269=item Project Coordinator 1486=item Project Coordinator
1270 1487
1271Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1488Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1272 1489
1273L<http://software.schmorp.de/#rxvt-unicode> 1490L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1274 1491
1275=back 1492=back
1276 1493
1277=head1 AUTHORS 1494=head1 AUTHORS
1278 1495
1300 1517
1301Project Coordinator (changes.txt 2.21a to 2.4.5) 1518Project Coordinator (changes.txt 2.21a to 2.4.5)
1302 1519
1303=item Geoff Wing L<< <gcw@pobox.com> >> 1520=item Geoff Wing L<< <gcw@pobox.com> >>
1304 1521
1305Rewrote screen display and text selection routines. Project Coordinator 1522Rewrote screen display and text selection routines.
1523
1306(changes.txt 2.4.6 - rxvt-unicode) 1524Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1307 1525
1308=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1526=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1309 1527
1310Forked rxvt-unicode, rewrote most of the display code and internal 1528Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1311character handling to store text in unicode, improve xterm 1529extension, random hacks, numerous bugfixes and extensions.
1312compatibility and apply numerous other bugfixes and extensions.
1313 1530
1314Project Coordinator (Changes 1.0 -) 1531Project Coordinator (Changes 1.0 -)
1315 1532
1533=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1534
1535Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1536
1316=back 1537=back
1317 1538

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines