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.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.115 by root, Mon Jul 10 04:01:33 2006 UTC

14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
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 frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
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>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
26world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
27especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
28like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
29like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
30scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
32as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
34such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
35change. 37change.
36 38
40because 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
41another for japanese. 43another for japanese.
42 44
43Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
44display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
45programs 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
46to choose any font for any script freely. 48to choose any font for any script freely.
47 49
48Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
49it'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
50in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot less bugs than the original
51rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
52 54
53It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
54and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
55without 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
56a 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
57from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
58drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
60 62
91 93
92Attempt 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
93respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
94B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
95 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
96=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
97 104
98Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
99 106
100=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 110
104=item B<-j>|B<+j> 111=item B<-j>|B<+j>
105 112
106Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling; resource B<jumpScroll>.
107 114
108=item B<-ip>|B<+ip> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 116
110Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
112 119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!>
122
113=item B<-fade> I<number> 123=item B<-fade> I<number>
114 124
115Fade the text by the given percentage when focus is lost. resource B<fading>. 125Fade the text by the given percentage when focus is lost. Small values
126fade a little only, 100 completely replaces all colours by the fade
127colour; resource B<fading>.
128
129=item B<-fadecolor> I<colour>
130
131Fade to this colour when fading is used (see B<-fade>). The default colour
132is opaque black. resource B<fadeColor>.
116 133
117=item B<-tint> I<colour> 134=item B<-tint> I<colour>
118 135
119Tint the transparent background pixmap with the given colour when 136Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 137transparency is enabled with B<-tr> or B<-ip>. This only works for
121option that can be used to brighten or darken the image in addition to 138non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 139used to brighten or darken the image in addition to tinting it; resource
140I<tintColor>. Example:
141
142 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 143
124=item B<-sh> 144=item B<-sh>
125 145
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 146I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 147background image in addition to tinting it (i.e. B<-tint> must be
160resource B<borderColor>. 180resource B<borderColor>.
161 181
162=item B<-fn> I<fontlist> 182=item B<-fn> I<fontlist>
163 183
164Select the fonts to be used. This is a comma separated list of font names 184Select the fonts to be used. This is a comma separated list of font names
165that are used in turn when trying to display Unicode characters. The 185that are checked in order when trying to find glyphs for characters. The
166first font defines the cell size for characters; other fonts might be 186first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A (hopefully) reasonable default 187smaller, but not (in general) larger. A (hopefully) reasonable default
168font list is always appended to it. See resource B<font> for more details. 188font list is always appended to it. See resource B<font> for more details.
169 189
170In short, to specify an X11 core font, just specify it's name or prefix it 190In short, to specify an X11 core font, just specify its name or prefix it
171with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 191with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172e.g.: 192e.g.:
173 193
174 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 194 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 195 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 197See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 198section of @@RXVT_NAME@@(7).
179 199
180=item B<-fb> I<fontlist> 200=item B<-fb> I<fontlist>
181 201
182Compile font-styles: The bold font list to use when bold characters are to 202Compile I<font-styles>: The bold font list to use when B<bold> characters
183be printed. See resource B<boldFont> for details. 203are to be printed. See resource B<boldFont> for details.
184 204
185=item B<-fi> I<fontlist> 205=item B<-fi> I<fontlist>
186 206
187Compile font-styles: The italic font list to use when bold characters are to 207Compile I<font-styles>: The italic font list to use when I<italic>
188be printed. See resource B<italicFont> for details. 208characters are to be printed. See resource B<italicFont> for details.
189 209
190=item B<-fbi> I<fontlist> 210=item B<-fbi> I<fontlist>
191 211
192Compile font-styles: The bold italic font list to use when bold characters are to 212Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193be printed. See resource B<boldItalicFont> for details. 213italic> >> characters are to be printed. See resource B<boldItalicFont>
214for details.
215
216=item B<-is>|B<+is>
217
218Compile I<font-styles>: Bold/Italic font styles imply high intensity
219foreground/background (default). See resource B<intensityStyles> for
220details.
194 221
195=item B<-name> I<name> 222=item B<-name> I<name>
196 223
197Specify the application name under which resources are to be obtained, 224Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 225rather than the default executable file name. Name should not contain
236 263
237Put scrollbar on right/left; resource B<scrollBar_right>. 264Put scrollbar on right/left; resource B<scrollBar_right>.
238 265
239=item B<-st>|B<+st> 266=item B<-st>|B<+st>
240 267
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 268Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 269resource B<scrollBar_floating>.
243 270
244=item B<-ptab>|B<+ptab> 271=item B<-ptab>|B<+ptab>
245 272
246If enabled (default), "Horizontal Tab" characters are being stored as 273If enabled (default), "Horizontal Tab" characters are being stored as
277=item B<-bl> 304=item B<-bl>
278 305
279Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280if honoured by the WM, the rxvt-unicode window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 308decorations; resource B<borderLess>.
309
310=item B<-override-redirect>
311
312Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>.
314
315=item B<-sbg>
316
317Compile I<frills>: Disable the usage of the built-in block graphics/line
318drawing characters and just rely on what the specified fonts provide. Use
319this if you have a good font and want to use its block graphic glyphs;
320resource B<skipBuiltinGlyphs>.
282 321
283=item B<-lsp> I<number> 322=item B<-lsp> I<number>
284 323
285Compile I<frills>: Lines (pixel height) to insert between each row of 324Compile I<frills>: Lines (pixel height) to insert between each row of
286the display. Useful to work around font rendering problems; resource 325the display. Useful to work around font rendering problems; resource
301given on the command line. If this option is used, it must be the last 340given on the command line. If this option is used, it must be the last
302on the command-line. If there is no B<-e> option then the default is to 341on the command-line. If there is no B<-e> option then the default is to
303run the program specified by the B<SHELL> environment variable or, 342run the program specified by the B<SHELL> environment variable or,
304failing that, I<sh(1)>. 343failing that, I<sh(1)>.
305 344
345Please note that you must specify a program with arguments. If you want to
346run shell commands, you have to specify the shell, like this:
347
348 @@RXVT_NAME@@ -e sh -c "shell commands"
349
306=item B<-title> I<text> 350=item B<-title> I<text>
307 351
308Window title (B<-T> still respected); the default title is the basename 352Window title (B<-T> still respected); the default title is the basename
309of the program specified after the B<-e> option, if any, otherwise the 353of the program specified after the B<-e> option, if any, otherwise the
310application name; resource B<title>. 354application name; resource B<title>.
366=item B<-ssr>|B<+ssr> 410=item B<-ssr>|B<+ssr>
367 411
368Turn on/off secondary screen scroll (default enabled); resource 412Turn on/off secondary screen scroll (default enabled); resource
369B<secondaryScroll>. 413B<secondaryScroll>.
370 414
415=item B<-hold>|B<+hold>
416
417Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418will not immediately destroy its window when the program executed within
419it exits. Instead, it will wait till it is being killed or closed by the
420user; resource B<hold>.
421
422=item B<-keysym.>I<sym> I<string>
423
424Remap a key symbol. See resource B<keysym>.
425
426=item B<-embed> I<windowid>
427
428Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
429which enables applications to easily embed a terminal.
430
431Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
432shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
433quite a bit, so don't expect it to keep some specific state. It's best to
434create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
435
436The window will not be destroyed when @@RXVT_NAME@@ exits.
437
438It might be useful to know that @@RXVT_NAME@@ will not close file
439descriptors passed to it (except for stdin/out/err, of course), so you
440can use file descriptors to communicate with the programs within the
441terminal. This works regardless of wether the C<-embed> option was used or
442not.
443
444Here is a short Gtk2-perl snippet that illustrates how this option can be
445used (a longer example is in F<doc/embed>):
446
447 my $rxvt = new Gtk2::Socket;
448 $rxvt->signal_connect_after (realize => sub {
449 my $xid = $_[0]->window->get_xid;
450 system "@@RXVT_NAME@@ -embed $xid &";
451 });
452
453=item B<-pty-fd> I<file descriptor>
454
455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456pair but instead use the given filehandle as the tty master. This is
457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458without having to run a program within it.
459
460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461entries and will not tinker with pty/tty permissions - you have to do that
462yourself if you want that.
463
464As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations.
466
467Here is a example in perl that illustrates how this option can be used (a
468longer example is in F<doc/pty-fd>):
469
470 use IO::Pty;
471 use Fcntl;
472
473 my $pty = new IO::Pty;
474 fcntl $pty, F_SETFD, 0; # clear close-on-exec
475 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
476 close $pty;
477
478 # now communicate with rxvt
479 my $slave = $pty->slave;
480 while (<$slave>) { print $slave "got <$_>\n" }
481
371=item B<-xrm> I<resourcestring> 482=item B<-pe> I<string>
372 483
373No effect on rxvt-unicode. Simply passes through an argument to be made 484Comma-separated list of perl extension scripts to use (or not to use) in
374available in the instance's argument list. Appears in I<WM_COMMAND> in 485this terminal instance. See resource B<perl-ext> for details.
375some window managers.
376 486
377=back 487=back
378 488
379=head1 RESOURCES (available also as long-options) 489=head1 RESOURCES (available also as long-options)
380 490
381Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382options) compiled into your version. 492options) compiled into your version.
383 493
384There are two different methods that @@RXVT_NAME@@ can use to get the 494You can set and change the resources using X11 tools like B<xrdb>. Many
385Xresource data: using the X libraries (Xrm*-functions) or internal 495distribution do also load settings from the B<~/.Xresources> file when X
386Xresources reader (B<~/.Xdefaults>). For the first method (ie. 496starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 497with later settings overwriting earlier ones:
388resources using X11 tools like B<xset>. Many distribution do also load
389settings from the B<~/.Xresources> file when X starts.
390 498
391If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 499 1. system-wide app-defaults file, either locale-dependent OR global
392lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 500 2. app-defaults file in $XAPPLRESDIR
393set in XAPPLOADDIR/URxvt (compile-time defined: usually 501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
394B</usr/lib/X11/app-defaults/URxvt>) and resources set in 502 4. SCREEN_RESOURCES for the current screen
395B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
504
396Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 506names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
398resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 507common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
399easily configured, while the class name B<URxvt> allows resources 508configured, while the class name B<URxvt> allows resources unique to
400unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 509B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401shared between different B<@@RXVT_NAME@@> configurations. If no 510configurations. If no resources are specified, suitable defaults will
402resources are specified, suitable defaults will be used. Command-line 511be used. Command-line arguments can be used to override resource
403arguments can be used to override resource settings. The following 512settings. The following resources are supported (you might want to
404resources are allowed: 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
514extensions not documented here):
405 515
406=over 4 516=over 4
517
518=item B<depth:> I<bitdepth>
519
520Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>.
407 522
408=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
409 524
410Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
411option B<-geometry>. 526option B<-geometry>.
485 600
486B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
487artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
488pixmap. 603pixmap.
489 604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
607
490=item B<fading:> I<number> 608=item B<fading:> I<number>
491 609
492Fade the text by the given percentage when focus is lost. 610Fade the text by the given percentage when focus is lost; option B<-fade>.
611
612=item B<fadeColor:> I<colour>
613
614Fade to this colour, when fading is used (see B<fading:>). The default
615colour is black; option B<-fadecolor>.
493 616
494=item B<tintColor:> I<colour> 617=item B<tintColor:> I<colour>
495 618
496Tint the transparent background pixmap with the given colour. 619Tint the transparent background pixmap with the given colour; option
620B<-tint>.
497 621
498=item B<shading:> I<number> 622=item B<shading:> I<number>
499 623
500Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 624Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
501image in addition to tinting it. 625image in addition to tinting it.
505Use the specified colour for the scrollbar [default #B2B2B2]. 629Use the specified colour for the scrollbar [default #B2B2B2].
506 630
507=item B<troughColor:> I<colour> 631=item B<troughColor:> I<colour>
508 632
509Use the specified colour for the scrollbar's trough area [default 633Use the specified colour for the scrollbar's trough area [default
510#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 634#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511 635
512=item B<borderColor:> I<colour> 636=item B<borderColor:> I<colour>
513 637
514The colour of the border around the text area and between the scrollbar 638The colour of the border around the text area and between the scrollbar
515and the text. 639and the text.
524of 1 displays the image without any scaling. A scale of 2 to 9 648of 1 displays the image without any scaling. A scale of 2 to 9
525specifies an integer number of images in that direction. No image will 649specifies an integer number of images in that direction. No image will
526be magnified beyond 10 times its original size. The maximum permitted 650be magnified beyond 10 times its original size. The maximum permitted
527scale is 1000. [default 0x0+50+50] 651scale is 1000. [default 0x0+50+50]
528 652
529=item B<menu:> I<file[;tag]>
530
531Read in the specified menu file (note the `.menu' extension is
532optional) and also optionally specify a starting tag to find. See the
533reference documentation for details on the syntax for the menuBar.
534
535=item B<path:> I<path> 653=item B<path:> I<path>
536 654
537Specify the colon-delimited search path for finding files (XPM and 655Specify the colon-delimited search path for finding XPM files.
538menus), in addition to the paths specified by the B<RXVTPATH> and
539B<PATH> environment variables.
540 656
541=item B<font:> I<fontlist> 657=item B<font:> I<fontlist>
542 658
543Select the fonts to be used. This is a comma separated list of font 659Select the fonts to be used. This is a comma separated list of font names
544names that are used in turn when trying to display Unicode characters. 660that are checked in order when trying to find glyphs for characters. The
545The first font defines the cell size for characters; other fonts might 661first font defines the cell size for characters; other fonts might be
546be smaller, but not larger. A reasonable default font list is always 662smaller, but not (in general) larger. A (hopefully) reasonable default
547appended to it. option B<-fn>. 663font list is always appended to it; option B<-fn>.
548 664
549Each font can either be a standard X11 core font (XLFD) name, with 665Each font can either be a standard X11 core font (XLFD) name, with
550optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 666optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551 667
552In addition, each font can be prefixed with additional hints and 668In addition, each font can be prefixed with additional hints and
554hint currently is C<codeset=codeset-name>, and this is only used for Xft 670hint currently is C<codeset=codeset-name>, and this is only used for Xft
555fonts. 671fonts.
556 672
557For example, this font resource 673For example, this font resource
558 674
559 URxvt*font: 9x15bold,\ 675 URxvt.font: 9x15bold,\
560 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 676 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
561 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 677 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
562 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 678 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563 xft:Code2000:antialias=false 679 xft:Code2000:antialias=false
564 680
598not possible, replacement fonts of the desired shape will be tried. 714not possible, replacement fonts of the desired shape will be tried.
599 715
600If set, but empty, then this specific style is disabled and the normal 716If set, but empty, then this specific style is disabled and the normal
601text font will being used for the given style. 717text font will being used for the given style.
602 718
719=item B<intensityStyles:> I<boolean>
720
721When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not
725reachable.
726
603=item B<selectstyle:> I<mode> 727=item B<selectstyle:> I<mode>
604 728
605Set mouse selection style to B<old> which is 2.20, B<oldword> which is 729Set mouse selection style to B<old> which is 2.20, B<oldword> which is
606xterm style with 2.20 old word selection, or anything else which gives 730xterm style with 2.20 old word selection, or anything else which gives
607xterm style selection. 731xterm style selection.
608 732
609=item B<scrollstyle:> I<mode> 733=item B<scrollstyle:> I<mode>
610 734
611Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 735Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612the author's favourite.. 736the author's favourite.
613 737
614=item B<title:> I<string> 738=item B<title:> I<string>
615 739
616Set window title string, the default title is the command-line 740Set window title string, the default title is the command-line
617specified after the B<-e> option, if any, otherwise the application 741specified after the B<-e> option, if any, otherwise the application
649 773
650Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 774Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 775B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652B<Shift-Print> to include the scrollback as well. 776B<Shift-Print> to include the scrollback as well.
653 777
778The string will be interpreted as if typed into the shell as-is.
779
780Example:
781
782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783
784This creates a new file in your home directory with the screen contents
785everytime you hit C<Print>.
786
654=item B<scrollBar:> I<boolean> 787=item B<scrollBar:> I<boolean>
655 788
656B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 789B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657disable the scrollbar; option B<+sb>. 790disable the scrollbar; option B<+sb>.
658 791
678B<+si>. 811B<+si>.
679 812
680=item B<scrollWithBuffer:> I<boolean> 813=item B<scrollWithBuffer:> I<boolean>
681 814
682B<True>: scroll with scrollback buffer when tty receives new lines (and 815B<True>: scroll with scrollback buffer when tty receives new lines (and
683B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 816B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684with scrollback buffer when tty recieves new lines; option B<-sw>. 817with scrollback buffer when tty recieves new lines; option B<+sw>.
685 818
686=item B<scrollTtyKeypress:> I<boolean> 819=item B<scrollTtyKeypress:> I<boolean>
687 820
688B<True>: scroll to bottom when a non-special key is pressed. Special keys 821B<True>: scroll to bottom when a non-special key is pressed. Special keys
689are those which are intercepted by rxvt-unicode for special handling and 822are those which are intercepted by rxvt-unicode for special handling and
708=item B<borderLess:> I<boolean> 841=item B<borderLess:> I<boolean>
709 842
710Set MWM hints to request a borderless window, i.e. if honoured by the 843Set MWM hints to request a borderless window, i.e. if honoured by the
711WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 844WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712 845
846=item B<skipBuiltinGlyphs:> I<boolean>
847
848Compile I<frills>: Disable the usage of the built-in block graphics/line
849drawing characters and just rely on what the specified fonts provide. Use
850this if you have a good font and want to use its block graphic glyphs;
851option B<-sbg>.
852
713=item B<termName:> I<termname> 853=item B<termName:> I<termname>
714 854
715Specifies the terminal type name to be set in the B<TERM> environment 855Specifies the terminal type name to be set in the B<TERM> environment
716variable; option B<-tn>. 856variable; option B<-tn>.
717 857
754 894
755Mouse pointer background colour. 895Mouse pointer background colour.
756 896
757=item B<pointerBlankDelay:> I<number> 897=item B<pointerBlankDelay:> I<number>
758 898
759Specifies number of seconds before blanking the pointer [default 2]. 899Specifies number of seconds before blanking the pointer [default 2]. Use a
900large number (e.g. C<987654321>) to effectively disable the timeout.
760 901
761=item B<backspacekey:> I<string> 902=item B<backspacekey:> I<string>
762 903
763The string to send when the backspace key is pressed. If set to B<DEC> 904The string to send when the backspace key is pressed. If set to B<DEC>
764or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 905or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
771pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
772with the B<Execute> key. 913with the B<Execute> key.
773 914
774=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
775 916
776The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
777built-in default: 918(whitespace delimiting is added automatically if resource is given).
919
920When the selection extension is in use (the default if compiled in, see
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
922will be created (if the resource exists, otherwise, no regex will be
923created). In this mode, characters outside ISO-8859-1 can be used.
924
925When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used:
778 927
779B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
780 929
781=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
782 931
789=item B<imLocale:> I<name> 938=item B<imLocale:> I<name>
790 939
791The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 940The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 941C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793input extension to be able to input japanese characters while staying in 942input extension to be able to input japanese characters while staying in
794another locale. option B<-imlocale>. 943another locale; option B<-imlocale>.
795 944
796=item B<imFont:> I<fontset> 945=item B<imFont:> I<fontset>
797 946
798Specify the font-set used for XIM styles C<OverTheSpot> or 947Specify the font-set used for XIM styles C<OverTheSpot> or
799C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 948C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
804 953
805=item B<tripleclickwords:> I<boolean> 954=item B<tripleclickwords:> I<boolean>
806 955
807Change the meaning of triple-click selection with the left mouse 956Change the meaning of triple-click selection with the left mouse
808button. Instead of selecting a full line it will extend the selection to 957button. Instead of selecting a full line it will extend the selection to
809the end of the logical line only. option B<-tcw>. 958the end of the logical line only; option B<-tcw>.
810 959
811=item B<insecure:> I<boolean> 960=item B<insecure:> I<boolean>
812 961
813Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 962Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814echo arbitrary strings like the icon name or the locale. This could be 963echo arbitrary strings like the icon name or the locale. This could be
815abused if somebody gets 8-bit-clean access to your display, whether 964abused if somebody gets 8-bit-clean access to your display, whether
816throuh a mail client displaying mail bodies unfiltered or though 965through a mail client displaying mail bodies unfiltered or through
817write(1). Therefore, these sequences are disabled by default. (Note 966write(1) or any other means. Therefore, these sequences are disabled by
818that other terminals, including xterm, have these sequences 967default. (Note that many other terminals, including xterm, have these
819enabled by default). You can enable them by setting this boolean 968sequences enabled by default, which doesn't make it safer, though).
820resource or specifying B<-insecure> as an option. At the moment, this 969
821enabled display-answer, locale, findfont, icon label and window title 970You can enable them by setting this boolean resource or specifying
822requests as well as dynamic menubar dispatch. 971B<-insecure> as an option. At the moment, this enables display-answer,
972locale, findfont, icon label and window title requests.
823 973
824=item B<modifier:> I<modifier> 974=item B<modifier:> I<modifier>
825 975
826Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 976Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 977B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
831 981
832Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 982Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
833character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
834in the entry on B<keysym> following. 984in the entry on B<keysym> following.
835 985
836=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
837 987
838Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
839 989
840=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
841 991
842Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
843option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
844scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
845instead scroll the screen up. 995instead scroll the screen up.
996
997=item B<hold>: I<boolean>
998
999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000will not immediately destroy its window when the program executed within
1001it exits. Instead, it will wait till it is being killed or closed by the
1002user.
846 1003
847=item B<keysym.>I<sym>: I<string> 1004=item B<keysym.>I<sym>: I<string>
848 1005
849Compile I<frills>: Associate I<string> with keysym I<sym>. The 1006Compile I<frills>: Associate I<string> with keysym I<sym>. The
850intervening resource name B<keysym.> cannot be omitted. 1007intervening resource name B<keysym.> cannot be omitted.
870C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
871C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1028C<\000>: octal number) or verbatim control characters (C<^?>: delete,
872C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
873can start or end with whitespace. 1030can start or end with whitespace.
874 1031
875Please note that you need to double the C<\> when using 1032Please note that you need to double the C<\> in resource files, as
876C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1033Xlib itself does its own de-escaping (you can use C<\033> instead of
877use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
878@@RXVT_NAME@@'s own processing). 1035processing).
879 1036
880You can define a range of keysyms in one shot by providing a I<string> 1037You can define a range of keysyms in one shot by providing a I<string>
881with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
882should be a character not used by the strings. 1039should be a character not used by the strings.
883 1040
896example the following means "change the current locale to C<zh_CN.GBK> 1053example the following means "change the current locale to C<zh_CN.GBK>
897when Control-Meta-c is being pressed": 1054when Control-Meta-c is being pressed":
898 1055
899 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1056 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900 1057
1058If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1059is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060manpage. For example, the F<selection> extension (activated via
1061C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062
1063 URxvt.keysym.M-C-c: perl:selection:rot13
1064
1065Due the the large number of modifier combinations, a defined key mapping
1066will match if at I<at least> the specified identifiers are being set, and
1067no other key mappings with those and more bits are being defined. That
1068means that defining a key map for C<a> will automatically provide
1069definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1070mappings themselves.
1071
1072Unfortunately, this will override built-in key mappings. For example
1073if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1074C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1075user-defined keymap using the C<builtin:> replacement:
1076
1077 URxvt.keysym.Insert: <my insert key sequence>
1078 URxvt.keysym.S-Insert: builtin:
1079
1080The first line defines a mapping for C<Insert> and I<any> combination
1081of modifiers. The second line re-establishes the default mapping for
1082C<Shift-Insert>.
1083
901The following example will map Control-Meta-1 and Control-Meta-2 to 1084The following example will map Control-Meta-1 and Control-Meta-2 to
902the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1085the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903font-switching at runtime: 1086font-switching at runtime:
904 1087
905 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1088 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
908Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1091Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909info): 1092info):
910 1093
911 URxvt.keysym.M-C-3: command:\033[8;25;80t 1094 URxvt.keysym.M-C-3: command:\033[8;25;80t
912 URxvt.keysym.M-C-4: command:\033[8;48;110t 1095 URxvt.keysym.M-C-4: command:\033[8;48;110t
1096
1097=item B<perl-ext-common>: I<string>
1098
1099=item B<perl-ext>: I<string>
1100
1101Comma-separated list(s) of perl extension scripts (default: C<default>) to
1102use in this terminal instance; option B<-pe>.
1103
1104Extension names can be prefixed with a C<-> sign to prohibit using
1105them. This can be useful to selectively disable some extensions loaded
1106by default, or specified via the C<perl-ext-common> resource. For
1107example, C<default,-selection> will use all the default extension except
1108C<selection>.
1109
1110Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to
1114the extension.
1115
1116Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance.
1118
1119If both of these resources are the empty string, then the perl
1120interpreter will not be initialized. The idea behind two options is that
1121B<perl-ext-common> will be used for extensions that should be available to
1122all instances, while B<perl-ext> is used for specific instances.
1123
1124=item B<perl-eval>: I<string>
1125
1126Perl code to be evaluated when all extensions have been registered. See
1127the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1128will be ignored when running setuid/setgid.
1129
1130=item B<perl-lib>: I<path>
1131
1132Colon-separated list of additional directories that hold extension
1133scripts. When looking for extensions specified by the C<perl> resource,
1134@@RXVT_NAME@@ will first look in these directories and then in
1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1136will be ignored when running setuid/setgid.
1137
1138See the @@RXVT_NAME@@perl(3) manpage.
1139
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141
1142Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1143details.
1144
1145=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1146
1147Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1148for details.
1149
1150=item B<searchable-scrollback:> I<keysym>
1151
1152Sets the hotkey that starts the incremental scrollback buffer search
1153(default: C<M-s>).
1154
1155=item B<urlLauncher>: I<string>
1156
1157Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions.
1159
1160=item B<transient-for>: I<windowid>
1161
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163
1164=item B<override-redirect>: I<boolean>
1165
1166Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>.
913 1168
914=back 1169=back
915 1170
916=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
917 1172
931the normal text selection/insertion, hold either the Shift or the Meta 1186the normal text selection/insertion, hold either the Shift or the Meta
932(Alt) key while performing the desired mouse action. 1187(Alt) key while performing the desired mouse action.
933 1188
934If mouse reporting mode is active, the normal scrollbar actions are 1189If mouse reporting mode is active, the normal scrollbar actions are
935disabled -- on the assumption that we are using a fullscreen 1190disabled -- on the assumption that we are using a fullscreen
936application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1191application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1192(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1193up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939respectively. 1194respectively.
940 1195
941=head1 TEXT SELECTION AND INSERTION 1196=head1 TEXT SELECTION AND INSERTION
942 1197
943The behaviour of text selection and insertion mechanism is similar to 1198The behaviour of text selection and insertion mechanism is similar to
952to select a word; Left triple-click to select the entire logical line 1207to select a word; Left triple-click to select the entire logical line
953(which can span multiple screen lines), unless modified by resource 1208(which can span multiple screen lines), unless modified by resource
954B<tripleclickwords>. 1209B<tripleclickwords>.
955 1210
956Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1211Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957(Compile: I<frills>) will create a rectangular selection instead of a normal 1212(Compile: I<frills>) will create a rectangular selection instead of a
958one. 1213normal one. In this mode, every selected row becomes its own line in the
1214selection, and trailing whitespace is visually underlined and removed from
1215the selection.
959 1216
960=item B<Insertion>: 1217=item B<Insertion>:
961 1218
962Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
963an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
964inserted as if it had been typed on the keyboard. 1221Meta modifier) to be inserted as if it had been typed on the keyboard.
1222
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too.
965 1225
966=back 1226=back
967 1227
968=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
969 1229
970Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
971supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
972 1232
973You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
974therefore using the menubar), e.g.:
975 1234
976 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1235 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1236
1237You can use keyboard shortcuts, too:
1238
1239 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1240 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
977 1241
978rxvt-unicode will automatically re-apply these fonts to the output so far. 1242rxvt-unicode will automatically re-apply these fonts to the output so far.
979 1243
980=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
981 1245
1009This mode lets you input characters representing the keycap symbols of 1273This mode lets you input characters representing the keycap symbols of
1010your keyboard, if representable in the current locale encoding. 1274your keyboard, if representable in the current locale encoding.
1011 1275
1012Start by pressing C<Control> and C<Shift> together, then releasing 1276Start by pressing C<Control> and C<Shift> together, then releasing
1013them. The next special key (cursor keys, home etc.) you enter will not 1277them. The next special key (cursor keys, home etc.) you enter will not
1014invoke it's usual function but instead will insert the corresponding 1278invoke its usual function but instead will insert the corresponding
1015keycap symbol. The symbol will only be entered when the key has been 1279keycap symbol. The symbol will only be entered when the key has been
1016released, otherwise pressing e.g. C<Shift> would enter the symbol for 1280released, otherwise pressing e.g. C<Shift> would enter the symbol for
1017C<ISO Level 2 Switch>, although your intention might have been to enter a 1281C<ISO Level 2 Switch>, although your intention might have been to enter a
1018reverse tab (Shift-Tab). 1282reverse tab (Shift-Tab).
1019 1283
1052=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1053 1317
1054In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1055B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1056high-intensity bold/blink versions of the same). Here is a list of the 1320high-intensity bold/blink versions of the same). Here is a list of the
1057colours with their B<rgb.txt> names. 1321colours with their names.
1058 1322
1059=begin table 1323=begin table
1060 1324
1061 B<color0> (black) = Black 1325 B<color0> (black) = Black
1062 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
1082It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1083B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1084a number 0-15, as a convenient shorthand to reference the colour name of 1348a number 0-15, as a convenient shorthand to reference the colour name of
1085color0-color15. 1349color0-color15.
1086 1350
1351In addition to the colours defined above, @@RXVT_NAME@@ offers an
1352additional 72 colours. The first 64 of those (with indices 16 to 79)
1353consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135416>), followed by 8 additional shades of gray (with indices 80 to 87).
1355
1356Together, all those colours implement the 88 colour xterm colours. Only
1357the first 16 can be changed using resources currently, the rest can only
1358be changed via command sequences ("escape codes").
1359
1087Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1088always swapping the foreground/background colours. This is in contrast to 1361always swapping the foreground/background colours. This is in contrast to
1089I<xterm>(1) where the colours are only swapped if they have not otherwise 1362I<xterm>(1) where the colours are only swapped if they have not otherwise
1090been specified. For example, 1363been specified. For example,
1091 1364
1096would yield White on Black, while on I<xterm>(1) it would yield Black 1369would yield White on Black, while on I<xterm>(1) it would yield Black
1097on White. 1370on White.
1098 1371
1099=back 1372=back
1100 1373
1374=head2 ALPHA CHANNEL SUPPORT
1375
1376If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379in addition to the ones provided by X, where the additional A component
1380specifies opacity (alpha) values. The minimum value of C<0> is completely
1381transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382to four hex digits specifiying the opacity value.
1383
1384You probably need to specify B<"-depth 32">, too, and have the luck that
1385your X-server uses ARGB pixel layout, as X is far from just supporting
1386ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388For example, the following selects an almost completely transparent red
1389background, and an almost opaque pink foreground:
1390
1391 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393I<Please note that transparency of any kind if completely unsupported by
1394the author. Don't bug him with installation questions!>
1395
1101=head1 ENVIRONMENT 1396=head1 ENVIRONMENT
1102 1397
1103B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1399
1105window id number of the B<@@RXVT_NAME@@> window and it also uses and 1400=over 4
1106sets the environment variable B<DISPLAY> to specify which display 1401
1107terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1402=item B<TERM>
1108B<RXVTPATH> and B<PATH> to find XPM files. 1403
1404Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405resources or on the commandline.
1406
1407=item B<COLORTERM>
1408
1409Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1410compiled with XPM support, and optionally with the added extension
1411C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1412
1413=item B<COLORFGBG>
1414
1415Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1416the colour code used as default foreground/text colour (or the string
1417C<default> to indicate that the default-colour escape sequence is to be
1418used), C<bg> is the colour code used as default background colour (or the
1419string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1420was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1421(and do) use this information to optimize screen output.
1422
1423=item B<WINDOWID>
1424
1425Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426window, which usually has subwindows for the scrollbar, the terminal
1427window and so on).
1428
1429=item B<TERMINFO>
1430
1431Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1432C<--with-terminfo=PATH>.
1433
1434=item B<DISPLAY>
1435
1436Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437display in its child processes.
1438
1439=item B<SHELL>
1440
1441The shell to be used for command execution, defaults to C</bin/sh>.
1442
1443=item B<RXVT_SOCKET>
1444
1445The unix domain socket path used by @@RXVT_NAME@@c(1) and
1446@@RXVT_NAME@@d(1).
1447
1448Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1449
1450=item B<HOME>
1451
1452Used to locate the default directory for the unix domain socket for
1453daemon communications and to locate various resource files (such as
1454C<.Xdefaults>)
1455
1456=item B<XAPPLRESDIR>
1457
1458Directory where various X resource files are being located.
1459
1460=item B<XENVIRONMENT>
1461
1462If set and accessible, gives the name of a X resource file to be loaded by
1463@@RXVT_NAME@@.
1464
1465=back
1109 1466
1110=head1 FILES 1467=head1 FILES
1111 1468
1112=over 4 1469=over 4
1113 1470
1117 1474
1118=back 1475=back
1119 1476
1120=head1 SEE ALSO 1477=head1 SEE ALSO
1121 1478
1122@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1479@@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)
1123
1124=head1 BUGS
1125
1126Check the BUGS file for an up-to-date list.
1127
1128Cursor change support is not yet implemented.
1129
1130Click-and-drag doesn't work with X11 mouse report overriding.
1131 1480
1132=head1 CURRENT PROJECT COORDINATOR 1481=head1 CURRENT PROJECT COORDINATOR
1133 1482
1134=over 4 1483=over 4
1135 1484
1136=item Project Coordinator 1485=item Project Coordinator
1137 1486
1138@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139 1488
1140=item Web page maintainter 1489L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1141
1142@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144L<@@RXVT_WEBPAGE@@>
1145 1490
1146=back 1491=back
1147 1492
1148=head1 AUTHORS 1493=head1 AUTHORS
1149 1494
1171 1516
1172Project Coordinator (changes.txt 2.21a to 2.4.5) 1517Project Coordinator (changes.txt 2.21a to 2.4.5)
1173 1518
1174=item Geoff Wing L<< <gcw@pobox.com> >> 1519=item Geoff Wing L<< <gcw@pobox.com> >>
1175 1520
1176Rewrote screen display and text selection routines. Project Coordinator 1521Rewrote screen display and text selection routines.
1522
1177(changes.txt 2.4.6 - rxvt-unicode) 1523Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1178 1524
1179=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1525=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180 1526
1181Forked rxvt-unicode, rewrote most of the display code and internal 1527Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1182character handling to store text in unicode, improve xterm 1528extension, random hacks, numerous bugfixes and extensions.
1183compatibility and apply numerous other bugfixes and extensions.
1184 1529
1185Project Coordinator (Changes 1.0 -) 1530Project Coordinator (Changes 1.0 -)
1186 1531
1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533
1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1535
1187=back 1536=back
1188 1537

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines