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.116 by root, Mon Jul 10 04:03:09 2006 UTC vs.
Revision 1.211 by sf-exg, Sat Dec 31 17:17:12 2011 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
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
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal 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 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
102 105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
108 116
109Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
110 118
111=item B<-j>|B<+j> 119=item B<-j>|B<+j>
112 120
113Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 122
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 126
120I<Please note that transparency of any kind if completely unsupported by 127=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions!> 128
129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
122 133
123=item B<-fade> I<number> 134=item B<-fade> I<number>
124 135
125Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
126fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
131Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
132is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
133 144
134=item B<-tint> I<colour> 145=item B<-tint> I<colour>
135 146
136Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
137transparency is enabled with B<-tr> or B<-ip>. This only works for 148resource I<tintColor>.
138non-tiled backgrounds, currently. See also the B<-sh> option that can be
139used to brighten or darken the image in addition to tinting it; resource
140I<tintColor>. Example:
141 149
142 @@RXVT_NAME@@ -tr -tint blue -sh 40 150=item B<-sh> I<number>
143 151
144=item B<-sh>
145
146I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
147background image in addition to tinting it (i.e. B<-tint> must be 153A value of 100 means no shading; resource I<shading>.
148specified, too, e.g. C<-tint white>). 154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified, the vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. The maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
149 179
150=item B<-bg> I<colour> 180=item B<-bg> I<colour>
151 181
152Window background colour; resource B<background>. 182Window background colour; resource B<background>.
153 183
154=item B<-fg> I<colour> 184=item B<-fg> I<colour>
155 185
156Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
157 187
158=item B<-pixmap> I<file[;geom]> 188=item B<-pixmap> I<file[;oplist]>
159 189
160Compile I<XPM>: Specify XPM file for the background and also optionally 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
161specify its scaling with a geometry string. Note you may need to 191optionally specify a list of operations to modify it. Note you may need to
162add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
163command-line; resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
164 194
165=item B<-cr> I<colour> 195=item B<-cr> I<colour>
166 196
167The cursor colour; resource B<cursorColor>. 197The cursor colour; resource B<cursorColor>.
168 198
213italic> >> characters are to be printed. See resource B<boldItalicFont> 243italic> >> characters are to be printed. See resource B<boldItalicFont>
214for details. 244for details.
215 245
216=item B<-is>|B<+is> 246=item B<-is>|B<+is>
217 247
218Compile I<font-styles>: Bold/Italic font styles imply high intensity 248Compile I<font-styles>: Bold/Blink font styles imply high intensity
219foreground/background (default). See resource B<intensityStyles> for 249foreground/background (default). See resource B<intensityStyles> for
220details. 250details.
221 251
222=item B<-name> I<name> 252=item B<-name> I<name>
223 253
241 271
242=item B<-sb>|B<+sb> 272=item B<-sb>|B<+sb>
243 273
244Turn on/off scrollbar; resource B<scrollBar>. 274Turn on/off scrollbar; resource B<scrollBar>.
245 275
276=item B<-sr>|B<+sr>
277
278Put scrollbar on right/left; resource B<scrollBar_right>.
279
280=item B<-st>|B<+st>
281
282Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
283resource B<scrollBar_floating>.
284
246=item B<-si>|B<+si> 285=item B<-si>|B<+si>
247 286
248Turn on/off scroll-to-bottom on TTY output inhibit; resource 287Turn on/off scroll-to-bottom on TTY output inhibit; resource
249B<scrollTtyOutput> has opposite effect. 288B<scrollTtyOutput> has opposite effect.
250 289
256=item B<-sw>|B<+sw> 295=item B<-sw>|B<+sw>
257 296
258Turn on/off scrolling with the scrollback buffer as new lines appear. 297Turn on/off scrolling with the scrollback buffer as new lines appear.
259This only takes effect if B<-si> is also given; resource 298This only takes effect if B<-si> is also given; resource
260B<scrollWithBuffer>. 299B<scrollWithBuffer>.
261
262=item B<-sr>|B<+sr>
263
264Put scrollbar on right/left; resource B<scrollBar_right>.
265
266=item B<-st>|B<+st>
267
268Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
269resource B<scrollBar_floating>.
270 300
271=item B<-ptab>|B<+ptab> 301=item B<-ptab>|B<+ptab>
272 302
273If enabled (default), "Horizontal Tab" characters are being stored as 303If enabled (default), "Horizontal Tab" characters are being stored as
274actual wide characters in the screen buffer, which makes it possible to 304actual wide characters in the screen buffer, which makes it possible to
278 308
279=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
280 310
281Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
282 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
283=item B<-iconic> 317=item B<-iconic>
284 318
285Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
286Alternative form is B<-ic>. 320Alternative form is B<-ic>.
287 321
303 337
304=item B<-bl> 338=item B<-bl>
305 339
306Compile I<frills>: Set MWM hints to request a borderless window, i.e. 340Compile I<frills>: Set MWM hints to request a borderless window, i.e.
307if honoured by the WM, the rxvt-unicode window will not have window 341if honoured by the WM, the rxvt-unicode window will not have window
308decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
309 344
310=item B<-override-redirect> 345=item B<-override-redirect>
311 346
312Compile I<frills>: Sets override-redirect on the window; resource 347Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>. 348B<override-redirect>.
321 356
322=item B<-lsp> I<number> 357=item B<-lsp> I<number>
323 358
324Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
325the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
326B<linespace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
327 369
328=item B<-tn> I<termname> 370=item B<-tn> I<termname>
329 371
330This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
331B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
385for more info. 427for more info.
386 428
387=item B<-tcw> 429=item B<-tcw>
388 430
389Change the meaning of triple-click selection with the left mouse 431Change the meaning of triple-click selection with the left mouse
432button. Only effective when the original (non-perl) selection code is
390button. Instead of selecting a full line it will extend the selection the 433in-use. Instead of selecting a full line it will extend the selection to
391end of the logical line only. resource B<tripleclickwords>. 434the end of the logical line only. resource B<tripleclickwords>.
392 435
393=item B<-insecure> 436=item B<-insecure>
394 437
395Enable "insecure" mode, which currently enables most of the escape 438Enable "insecure" mode, which currently enables most of the escape
396sequences that echo strings. See the resource B<insecure> for more 439sequences that echo strings. See the resource B<insecure> for more
417Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418will not immediately destroy its window when the program executed within 461will 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 462it exits. Instead, it will wait till it is being killed or closed by the
420user; resource B<hold>. 463user; resource B<hold>.
421 464
465=item B<-cd> I<path>
466
467Sets the working directory for the shell (or the command specified via
468B<-e>). The I<path> must be an absolute path and it must exist for
469@@RXVT_NAME@@ to start; resource B<chdir>.
470
471=item B<-xrm> I<string>
472
473Works like the X Toolkit option of the same name, by adding the I<string>
474as if it were specified in a resource file. Resource values specified this
475way take precedence over all other resource specifications.
476
477Note that you need to use the I<same> syntax as in the .Xdefaults file,
478e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
479options can be specified as long-options on the commandline, so use
480of B<-xrm> is mostly limited to cases where you want to specify other
481resources (e.g. for input methods) or for compatibility with other
482programs.
483
422=item B<-keysym.>I<sym> I<string> 484=item B<-keysym.>I<sym> I<string>
423 485
424Remap a key symbol. See resource B<keysym>. 486Remap a key symbol. See resource B<keysym>.
425 487
426=item B<-embed> I<windowid> 488=item B<-embed> I<windowid>
436The window will not be destroyed when @@RXVT_NAME@@ exits. 498The window will not be destroyed when @@RXVT_NAME@@ exits.
437 499
438It might be useful to know that @@RXVT_NAME@@ will not close file 500It 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 501descriptors passed to it (except for stdin/out/err, of course), so you
440can use file descriptors to communicate with the programs within the 502can use file descriptors to communicate with the programs within the
441terminal. This works regardless of wether the C<-embed> option was used or 503terminal. This works regardless of whether the C<-embed> option was used or
442not. 504not.
443 505
444Here is a short Gtk2-perl snippet that illustrates how this option can be 506Here is a short Gtk2-perl snippet that illustrates how this option can be
445used (a longer example is in F<doc/embed>): 507used (a longer example is in F<doc/embed>):
446 508
451 }); 513 });
452 514
453=item B<-pty-fd> I<file descriptor> 515=item B<-pty-fd> I<file descriptor>
454 516
455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 517Tells @@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 518pair but instead use the given file descriptor as the tty master. This is
457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 519useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458without having to run a program within it. 520without having to run a program within it.
459 521
460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 522If 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 523entries and will not tinker with pty/tty permissions - you have to do that
462yourself if you want that. 524yourself if you want that.
463 525
464As an extremely special case, specifying C<-1> will completely suppress 526As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations. 527pty/tty operations, which is probably only useful in conjunction with some
528perl extension that manages the terminal.
466 529
467Here is a example in perl that illustrates how this option can be used (a 530Here is a example in perl that illustrates how this option can be used (a
468longer example is in F<doc/pty-fd>): 531longer example is in F<doc/pty-fd>):
469 532
470 use IO::Pty; 533 use IO::Pty;
484Comma-separated list of perl extension scripts to use (or not to use) in 547Comma-separated list of perl extension scripts to use (or not to use) in
485this terminal instance. See resource B<perl-ext> for details. 548this terminal instance. See resource B<perl-ext> for details.
486 549
487=back 550=back
488 551
489=head1 RESOURCES (available also as long-options) 552=head1 RESOURCES
490 553
491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 554Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492options) compiled into your version. 555options) compiled into your version. All resources are also available as
556long-options.
493 557
494You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
495distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
496starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
498 562
499 1. system-wide app-defaults file, either locale-dependent OR global
500 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
502 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline
504 569
505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
506names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
507common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 572common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
508configured, while the class name B<URxvt> allows resources unique to 573configured, while the class name B<URxvt> allows resources unique to
518=item B<depth:> I<bitdepth> 583=item B<depth:> I<bitdepth>
519 584
520Compile I<xft>: Attempt to find a visual with the given bit depth; 585Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>. 586option B<-depth>.
522 587
588=item B<buffered:> I<boolean>
589
590Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
591On some card/driver combination enabling it slightly decreases
592performance, on most it greatly helps it. The slowdown is small, so it
593should normally be enabled.
594
523=item B<geometry:> I<geom> 595=item B<geometry:> I<geom>
524 596
525Create the window with the specified X window geometry [default 80x24]; 597Create the window with the specified X window geometry [default 80x24];
526option B<-geometry>. 598option B<-geometry>.
527 599
540Use the specified colour for the colour value I<n>, where 0-7 612Use the specified colour for the colour value I<n>, where 0-7
541corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
542high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
543colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5443=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
545names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
546 618
547Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
548changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
549 621
550Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
561=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
562 634
563Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
564foreground colour is the default. 636foreground colour is the default.
565 637
566=item B<colorRV:> I<colour>
567
568Use the specified colour as the background for reverse video
569characters.
570
571=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
572 639
573If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
574itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
575 652
576=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
577 654
578Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
579foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
586 663
587=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
588 665
589B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
590option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
591B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
592 669
593=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
594 671
595B<True>: specify that jump scrolling should be used. When scrolling 672B<True>: specify that jump scrolling should be used. When receiving lots
596quickly, fewer screen updates are performed [default]; option B<-j>. 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
674has been read, resulting in fewer updates while still displaying every
675received line; option B<-j>.
676
597B<False>: specify that smooth scrolling should be used; option B<+j>. 677B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
678force a screen refresh on each new line it received; option B<+j>.
598 679
599=item B<inheritPixmap:> I<boolean> 680=item B<skipScroll:> I<boolean>
600 681
601B<True>: make the background inherit the parent windows' pixmap, giving 682B<True>: (the default) specify that skip scrolling should be used. When
602artificial transparency. B<False>: do not inherit the parent windows' 683receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603pixmap. 684(around 60 times per second), resulting in far fewer updates. This can
685result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
686option B<-ss>.
604 687
605I<Please note that transparency of any kind if completely unsupported by 688B<False>: specify that everything is to be displayed, even
606the author. Don't bug him with installation questions!> 689if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>.
691
692=item B<transparent:> I<boolean>
693
694Turn on/off pseudo-transparency by using the root pixmap as background.
695
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697future versions.
607 698
608=item B<fading:> I<number> 699=item B<fading:> I<number>
609 700
610Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
611 702
614Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
615colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
616 707
617=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
618 709
619Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
620B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
621 715
622=item B<shading:> I<number> 716=item B<shading:> I<number>
623 717
624Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
625image in addition to tinting it. 719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
626 733
627=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
628 735
629Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
630 737
636=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
637 744
638The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
639and the text. 746and the text.
640 747
641=item B<backgroundPixmap:> I<file[;geom]> 748=item B<backgroundPixmap:> I<file[;oplist]>
642 749
643Use the specified XPM file (note the `.xpm' extension is optional) for 750Use the specified image file for the background and also
644the background and also optionally specify its scaling with a geometry 751optionally specify a colon separated list of operations to modify it.
645string B<WxH+X+Y>, in which B<"W" / "H"> specify the 752Supported operations are:
646horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 753
647centre (percent). A scale of 0 displays the image with tiling. A scale 754=over 4
648of 1 displays the image without any scaling. A scale of 2 to 9 755
649specifies an integer number of images in that direction. No image will 756=item B<WxH+X+Y>
650be magnified beyond 10 times its original size. The maximum permitted 757
651scale is 1000. [default 0x0+50+50] 758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760scale of 0 disables scaling. The maximum permitted scale is 1000.
761
762=item B<op=tile>
763
764enables tiling
765
766=item B<op=keep-aspect>
767
768maintain the image aspect ratio when scaling
769
770=item B<op=root-align>
771
772use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background
774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
778Alternatively, a predefined set of templates can be used to achieve
779the most common setups:
780
781=over 4
782
783=item B<style=tiled>
784
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787=item B<style=aspect-stretched>
788
789the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
791
792=item B<style=stretched>
793
794the image is scaled to fill the whole window. Equivalent to 100x100
795
796=item B<style=centered>
797
798the image is centered with no scaling. Equivalent to 0x0+50+50
799
800=item B<style=root-tiled>
801
802the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root-align
804
805=back
806
807If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings.
809
810If used in conjunction with B<-tr> option, the specified pixmap will be
811blended over the transparent background using alpha-blending. If I<afterimage>
812support has been compiled in it is possible to choose other blending
813types with B<-blt "type"> option.
652 814
653=item B<path:> I<path> 815=item B<path:> I<path>
654 816
655Specify the colon-delimited search path for finding XPM files. 817Specify the colon-delimited search path for finding background image files.
656 818
657=item B<font:> I<fontlist> 819=item B<font:> I<fontlist>
658 820
659Select the fonts to be used. This is a comma separated list of font names 821Select the fonts to be used. This is a comma separated list of font names
660that are checked in order when trying to find glyphs for characters. The 822that are checked in order when trying to find glyphs for characters. The
683it is named first) and thus defines the character cell grid to be 9 pixels 845it is named first) and thus defines the character cell grid to be 9 pixels
684wide and 15 pixels high. 846wide and 15 pixels high.
685 847
686The second font is just used to add additional unicode characters not in 848The second font is just used to add additional unicode characters not in
687the base font, likewise the third, which is unfortunately non-bold, but 849the base font, likewise the third, which is unfortunately non-bold, but
688the bold version of the font does contain less characters, so this is a 850the bold version of the font does contain fewer characters, so this is a
689useful supplement. 851useful supplement.
690 852
691The third font is an Xft font with aliasing turned off, and the characters 853The third font is an Xft font with aliasing turned off, and the characters
692are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 854are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
693contains other characters, but we are not interested in them. 855contains other characters, but we are not interested in them.
717text font will being used for the given style. 879text font will being used for the given style.
718 880
719=item B<intensityStyles:> I<boolean> 881=item B<intensityStyles:> I<boolean>
720 882
721When font styles are not enabled, or this option is enabled (B<True>, 883When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high 884option B<-is>, the default), bold/blink font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>, 885intensity foreground/background colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not 886option B<+is>) disables this behaviour, the high intensity colours are not
725reachable. 887reachable.
726
727=item B<selectstyle:> I<mode>
728
729Set mouse selection style to B<old> which is 2.20, B<oldword> which is
730xterm style with 2.20 old word selection, or anything else which gives
731xterm style selection.
732
733=item B<scrollstyle:> I<mode>
734
735Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736the author's favourite.
737 888
738=item B<title:> I<string> 889=item B<title:> I<string>
739 890
740Set window title string, the default title is the command-line 891Set window title string, the default title is the command-line
741specified after the B<-e> option, if any, otherwise the application 892specified after the B<-e> option, if any, otherwise the application
750=item B<mapAlert:> I<boolean> 901=item B<mapAlert:> I<boolean>
751 902
752B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 903B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753de-iconify (map) on receipt of a bell character [default]. 904de-iconify (map) on receipt of a bell character [default].
754 905
906=item B<urgentOnBell:> I<boolean>
907
908B<True>: set the urgency hint for the wm on receipt of a bell character.
909B<False>: do not set the urgency hint [default].
910
911@@RXVT_NAME@@ resets the urgency hint on every focus change.
912
755=item B<visualBell:> I<boolean> 913=item B<visualBell:> I<boolean>
756 914
757B<True>: use visual bell on receipt of a bell character; option B<-vb>. 915B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758B<False>: no visual bell [default]; option B<+vb>. 916B<False>: no visual bell [default]; option B<+vb>.
759 917
780Example: 938Example:
781 939
782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 940 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783 941
784This creates a new file in your home directory with the screen contents 942This creates a new file in your home directory with the screen contents
785everytime you hit C<Print>. 943every time you hit C<Print>.
944
945=item B<scrollstyle:> I<mode>
946
947Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
948the author's favourite.
949
950=item B<thickness:> I<number>
951
952Set the scrollbar width in pixels.
786 953
787=item B<scrollBar:> I<boolean> 954=item B<scrollBar:> I<boolean>
788 955
789B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 956B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790disable the scrollbar; option B<+sb>. 957disable the scrollbar; option B<+sb>.
810B<False>: do not scroll to bottom when tty receives output; option 977B<False>: do not scroll to bottom when tty receives output; option
811B<+si>. 978B<+si>.
812 979
813=item B<scrollWithBuffer:> I<boolean> 980=item B<scrollWithBuffer:> I<boolean>
814 981
815B<True>: scroll with scrollback buffer when tty receives new lines (and 982B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
816B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 983try to show the same lines) and B<scrollTtyOutput> is False; option
817with scrollback buffer when tty recieves new lines; option B<+sw>. 984B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
985new lines; option B<+sw>.
818 986
819=item B<scrollTtyKeypress:> I<boolean> 987=item B<scrollTtyKeypress:> I<boolean>
820 988
821B<True>: scroll to bottom when a non-special key is pressed. Special keys 989B<True>: scroll to bottom when a non-special key is pressed. Special keys
822are those which are intercepted by rxvt-unicode for special handling and 990are those which are intercepted by rxvt-unicode for special handling and
853=item B<termName:> I<termname> 1021=item B<termName:> I<termname>
854 1022
855Specifies the terminal type name to be set in the B<TERM> environment 1023Specifies the terminal type name to be set in the B<TERM> environment
856variable; option B<-tn>. 1024variable; option B<-tn>.
857 1025
858=item B<linespace:> I<number> 1026=item B<lineSpace:> I<number>
859 1027
860Specifies number of lines (pixel height) to insert between each row of 1028Specifies number of lines (pixel height) to insert between each row of
861the display [default 0]; option B<-lsp>. 1029the display [default 0]; option B<-lsp>.
862 1030
863=item B<meta8:> I<boolean> 1031=item B<meta8:> I<boolean>
877 1045
878=item B<cursorBlink:> I<boolean> 1046=item B<cursorBlink:> I<boolean>
879 1047
880B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1048B<True>: blink the cursor. B<False>: do not blink the cursor [default];
881option B<-bc>. 1049option B<-bc>.
1050
1051=item B<cursorUnderline:> I<boolean>
1052
1053B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1054option B<-uc>.
882 1055
883=item B<pointerBlank:> I<boolean> 1056=item B<pointerBlank:> I<boolean>
884 1057
885B<True>: blank the pointer when a key is pressed or after a set number 1058B<True>: blank the pointer when a key is pressed or after a set number
886of seconds of inactivity. B<False>: the pointer is always visible 1059of seconds of inactivity. B<False>: the pointer is always visible
900large number (e.g. C<987654321>) to effectively disable the timeout. 1073large number (e.g. C<987654321>) to effectively disable the timeout.
901 1074
902=item B<backspacekey:> I<string> 1075=item B<backspacekey:> I<string>
903 1076
904The string to send when the backspace key is pressed. If set to B<DEC> 1077The string to send when the backspace key is pressed. If set to B<DEC>
905or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1078or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
906(code 8) - which can be reversed with the appropriate DEC private mode 1079(code 8) - which can be reversed with the appropriate DEC private mode
907escape sequence. 1080escape sequence.
908 1081
909=item B<deletekey:> I<string> 1082=item B<deletekey:> I<string>
910 1083
915=item B<cutchars:> I<string> 1088=item B<cutchars:> I<string>
916 1089
917The characters used as delimiters for double-click word selection 1090The characters used as delimiters for double-click word selection
918(whitespace delimiting is added automatically if resource is given). 1091(whitespace delimiting is added automatically if resource is given).
919 1092
920When the selection extension is in use (the default if compiled in, see 1093When the perl selection extension is in use (the default if compiled
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1094in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922will be created (if the resource exists, otherwise, no regex will be 1095characters will be created (if the resource exists, otherwise, no regex
923created). In this mode, characters outside ISO-8859-1 can be used. 1096will be created). In this mode, characters outside ISO-8859-1 can be used.
924 1097
925When the selection extension is not used, only ISO-8859-1 characters can 1098When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used: 1099be used. If not specified, the built-in default is used:
927 1100
928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1101B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
929 1102
930=item B<preeditType:> I<style> 1103=item B<preeditType:> I<style>
931 1104
932B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1105B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933 1106
987 1160
988Turn on/off secondary screen (default enabled). 1161Turn on/off secondary screen (default enabled).
989 1162
990=item B<secondaryScroll:> I<boolean> 1163=item B<secondaryScroll:> I<boolean>
991 1164
992Turn on/off secondary screen scroll (default enabled). If the this 1165Turn on/off secondary screen scroll (default enabled). If this
993option is enabled, scrolls on the secondary screen will change the 1166option is enabled, scrolls on the secondary screen will change the
994scrollback buffer and switching to/from the secondary screen will 1167scrollback buffer and, when secondaryScreen is off, switching
995instead scroll the screen up. 1168to/from the secondary screen will instead scroll the screen up.
996 1169
997=item B<hold>: I<boolean> 1170=item B<hold>: I<boolean>
998 1171
999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1172Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000will not immediately destroy its window when the program executed within 1173will 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 1174it exits. Instead, it will wait till it is being killed or closed by the
1002user. 1175user.
1176
1177=item B<chdir>: I<path>
1178
1179Sets the working directory for the shell (or the command specified via
1180B<-e>). The I<path> must be an absolute path and it must exist for
1181@@RXVT_NAME@@ to start. If it isn't specified then the current working
1182directory will be used; option B<-cd>.
1003 1183
1004=item B<keysym.>I<sym>: I<string> 1184=item B<keysym.>I<sym>: I<string>
1005 1185
1006Compile I<frills>: Associate I<string> with keysym I<sym>. The 1186Compile I<frills>: Associate I<string> with keysym I<sym>. The
1007intervening resource name B<keysym.> cannot be omitted. 1187intervening resource name B<keysym.> cannot be omitted.
1021searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1201searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1022omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1202omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1023keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1203keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1024performed in an exact manner; however, the closest match is assured. 1204performed in an exact manner; however, the closest match is assured.
1025 1205
1026I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1207number), see RESOURCES in C<man 7 X> for further details.
1028C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030can start or end with whitespace.
1031 1208
1032Please note that you need to double the C<\> in resource files, as
1033Xlib itself does its own de-escaping (you can use C<\033> instead of
1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035processing).
1036
1037You can define a range of keysyms in one shot by providing a I<string> 1209You can define a range of keysyms in one shot by
1210loading the C<keysym-list> perl extension and providing a I<string>
1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1211with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039should be a character not used by the strings. 1212should be a character not used by the strings.
1040 1213
1041Its usage can be demonstrated by an example: 1214Its usage can be demonstrated by an example:
1042 1215
1043 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1216 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1044 1217
1045The above line is equivalent to the following three lines: 1218The above line is equivalent to the following three lines:
1046 1219
1047 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1220 URxvt.keysym.Meta-Control-0x61: \033<a>
1048 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1221 URxvt.keysym.Meta-Control-0x62: \033<b>
1049 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1222 URxvt.keysym.Meta-Control-0x63: \033<c>
1050 1223
1051If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1224If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1052is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1225is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1053example the following means "change the current locale to C<zh_CN.GBK> 1226example the following means "change the current locale to C<zh_CN.GBK>
1054when Control-Meta-c is being pressed": 1227when Control-Meta-c is being pressed":
1055 1228
1056 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1229 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057 1230
1058If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1231If 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) 1232is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060manpage. For example, the F<selection> extension (activated via 1233manpage. For example, the F<selection> extension (activated via
1061C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1234C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062 1235
1063 URxvt.keysym.M-C-c: perl:selection:rot13 1236 URxvt.keysym.M-C-c: perl:selection:rot13
1064 1237
1065Due the the large number of modifier combinations, a defined key mapping 1238Due 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 1239will match if I<at least> the specified identifiers are being set, and
1067no other key mappings with those and more bits are being defined. That 1240no other key mappings with those and more bits are being defined. That
1068means that defining a key map for C<a> will automatically provide 1241means 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 1242definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1070mappings themselves. 1243mappings themselves.
1071 1244
1107example, C<default,-selection> will use all the default extension except 1280example, C<default,-selection> will use all the default extension except
1108C<selection>. 1281C<selection>.
1109 1282
1110Extension names can also be followed by an argument in angle brackets 1283Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1284(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension 1285searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to 1286multiple times with different arguments will pass multiple arguments to
1114the extension. 1287the extension.
1115 1288
1116Each extension is looked up in the library directories, loaded if 1289Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance. 1290necessary, and bound to the current terminal instance.
1122all instances, while B<perl-ext> is used for specific instances. 1295all instances, while B<perl-ext> is used for specific instances.
1123 1296
1124=item B<perl-eval>: I<string> 1297=item B<perl-eval>: I<string>
1125 1298
1126Perl code to be evaluated when all extensions have been registered. See 1299Perl code to be evaluated when all extensions have been registered. See
1127the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1300the @@RXVT_NAME@@perl(3) manpage.
1128will be ignored when running setuid/setgid.
1129 1301
1130=item B<perl-lib>: I<path> 1302=item B<perl-lib>: I<path>
1131 1303
1132Colon-separated list of additional directories that hold extension 1304Colon-separated list of additional directories that hold extension
1133scripts. When looking for extensions specified by the C<perl> resource, 1305scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1134@@RXVT_NAME@@ will first look in these directories and then in 1306look in these directories, then in $HOME/.urxvt/ext and lastly in
1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1307F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1136will be ignored when running setuid/setgid.
1137 1308
1138See the @@RXVT_NAME@@perl(3) manpage. 1309See the @@RXVT_NAME@@perl(3) manpage.
1139 1310
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1311=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141 1312
1153(default: C<M-s>). 1324(default: C<M-s>).
1154 1325
1155=item B<urlLauncher>: I<string> 1326=item B<urlLauncher>: I<string>
1156 1327
1157Specifies the program to be started with a URL argument. Used by the 1328Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions. 1329C<selection-popup> and C<matcher> perl extensions.
1159 1330
1160=item B<transient-for>: I<windowid> 1331=item B<transient-for>: I<windowid>
1161 1332
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1333Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163 1334
1164=item B<override-redirect>: I<boolean> 1335=item B<override-redirect>: I<boolean>
1165 1336
1166Compile I<frills>: Sets override-redirect for the terminal window, making 1337Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>. 1338it almost invisible to window managers; option B<-override-redirect>.
1339
1340=item B<iso14755:> I<boolean>
1341
1342Turn on/off ISO 14755 (default enabled).
1343
1344=item B<iso14755_52:> I<boolean>
1345
1346Turn on/off ISO 14755 5.2 mode (default enabled).
1168 1347
1169=back 1348=back
1170 1349
1171=head1 THE SCROLLBAR 1350=head1 THE SCROLLBAR
1172 1351
1191application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1370application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1371(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1193up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1372up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194respectively. 1373respectively.
1195 1374
1196=head1 TEXT SELECTION AND INSERTION 1375=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197 1376
1198The behaviour of text selection and insertion mechanism is similar to 1377The behaviour of text selection and insertion/pasting mechanism is similar
1199I<xterm>(1). 1378to I<xterm>(1).
1200 1379
1201=over 4 1380=over 4
1202 1381
1203=item B<Selection>: 1382=item B<Selecting>:
1204 1383
1205Left click at the beginning of the region, drag to the end of the region 1384Left click at the beginning of the region, drag to the end of the region
1206and release; Right click to extend the marked region; Left double-click 1385and release; Right click to extend the marked region; Left double-click
1207to select a word; Left triple-click to select the entire logical line 1386to select a word; Left triple-click to select the entire logical line
1208(which can span multiple screen lines), unless modified by resource 1387(which can span multiple screen lines), unless modified by resource
1212(Compile: I<frills>) will create a rectangular selection instead of a 1391(Compile: I<frills>) will create a rectangular selection instead of a
1213normal one. In this mode, every selected row becomes its own line in the 1392normal one. In this mode, every selected row becomes its own line in the
1214selection, and trailing whitespace is visually underlined and removed from 1393selection, and trailing whitespace is visually underlined and removed from
1215the selection. 1394the selection.
1216 1395
1217=item B<Insertion>: 1396=item B<Pasting>:
1218 1397
1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1398Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220window causes the value of the PRIMARY selection (or CLIPBOARD with the 1399window causes the value of the PRIMARY selection (or CLIPBOARD with the
1221Meta modifier) to be inserted as if it had been typed on the keyboard. 1400B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222 1401
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1402Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too. 1403inserted too.
1225 1404
1226=back 1405=back
1243 1422
1244=head1 ISO 14755 SUPPORT 1423=head1 ISO 14755 SUPPORT
1245 1424
1246ISO 14755 is a standard for entering and viewing unicode characters 1425ISO 14755 is a standard for entering and viewing unicode characters
1247and character codes using the keyboard. It consists of 4 parts. The 1426and character codes using the keyboard. It consists of 4 parts. The
1248first part is available rxvt-unicode has been compiled with 1427first part is available if rxvt-unicode has been compiled with
1249C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1428C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250with C<--enable-iso14755>. 1429with C<--enable-iso14755>.
1251 1430
1252=over 4 1431=over 4
1253 1432
1311B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1490B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1312it can be seen via the I<who(1)> command, and can accept messages. To 1491it can be seen via the I<who(1)> command, and can accept messages. To
1313allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1492allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1314on some systems or setgid to root or to some other group on others. 1493on some systems or setgid to root or to some other group on others.
1315 1494
1316=head1 COLORS AND GRAPHICS 1495=head1 COLOURS AND GRAPHICS
1317 1496
1318In addition to the default foreground and background colours, 1497In addition to the default foreground and background colours,
1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1498B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1320high-intensity bold/blink versions of the same). Here is a list of the 1499high-intensity (potentially bold/blink) versions of the same, and 72 (or
1321colours with their names. 1500240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1501cube plus a 8 (24) colour greyscale ramp.
1502
1503Here is a list of the ANSI colours with their names.
1322 1504
1323=begin table 1505=begin table
1324 1506
1325 B<color0> (black) = Black 1507 B<color0> (black) = Black
1326 B<color1> (red) = Red3 1508 B<color1> (red) = Red3
1346It is also possible to specify the colour values of B<foreground>, 1528It is also possible to specify the colour values of B<foreground>,
1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1529B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1348a number 0-15, as a convenient shorthand to reference the colour name of 1530a number 0-15, as a convenient shorthand to reference the colour name of
1349color0-color15. 1531color0-color15.
1350 1532
1351In addition to the colours defined above, @@RXVT_NAME@@ offers an 1533The following text gives values for the standard 88 colour mode (and
1352additional 72 colours. The first 64 of those (with indices 16 to 79) 1534values for the 256 colour mode in parentheses).
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 1535
1536The RGB cube uses indices 16..79 (16..231) using the following formulas:
1537
1538 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1539 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1540
1541The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1542steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1543the RGB cube.
1544
1356Together, all those colours implement the 88 colour xterm colours. Only 1545Together, all those colours implement the 88 (256) colour xterm
1357the first 16 can be changed using resources currently, the rest can only 1546colours. Only the first 16 can be changed using resources currently, the
1358be changed via command sequences ("escape codes"). 1547rest can only be changed via command sequences ("escape codes").
1548
1549Applications are advised to use terminfo or command sequences to discover
1550number and RGB values of all colours (yes, you can query this...).
1359 1551
1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1552Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1361always swapping the foreground/background colours. This is in contrast to 1553always swapping the foreground/background colours. This is in contrast to
1362I<xterm>(1) where the colours are only swapped if they have not otherwise 1554I<xterm>(1) where the colours are only swapped if they have not otherwise
1363been specified. For example, 1555been specified. For example,
1364 1556
1557 @@RXVT_NAME@@ -fg Black -bg White -rv
1558
1559would yield White on Black, while on I<xterm>(1) it would yield Black on
1560White.
1561
1562=head2 ALPHA CHANNEL SUPPORT
1563
1564If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1565their act together, rxvt-unicode will do its own alpha channel management:
1566
1567You can prefix any colour with an opaqueness percentage enclosed in
1568brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1569(0-100) that specifies the opacity of the colour, where C<0> is completely
1570transparent and C<100> is completely opaque. For example, C<[50]red> is a
1571half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1572is the recommended format to specify transparency values, and works with
1573all ways to specify a colour.
1574
1575For complete control, rxvt-unicode also supports
1576C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1577specifications, where the additional C<aaaa> component specifies opacity
1578(alpha) values. The minimum value of C<0000> is completely transparent,
1579while C<ffff> is completely opaque). The two example colours from
1580earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1581C<rgba:0000/ff00/0000/f332>.
1582
1583You probably need to specify B<"-depth 32">, too, to force a visual with
1584alpha channels, and have the luck that your X-server uses ARGB pixel
1585layout, as X is far from just supporting ARGB visuals out of the box, and
1586rxvt-unicode just fudges around.
1587
1588For example, the following selects an almost completely transparent black
1589background, and an almost opaque pink foreground:
1590
1591 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1592
1593When not using a background image, then the interpretation of the
1594alpha channel is up to your compositing manager (most interpret it as
1595transparency of course).
1596
1597When using a background pixmap or pseudo-transparency, then the background
1598colour will always behave as if it were completely transparent (so the
1599background image shows instead), regardless of how it was specified, while
1600other colours will either be transparent as specified (the background
1601image will show through) on servers supporting the RENDER extension, or
1602fully opaque on servers not supporting the RENDER EXTENSION.
1603
1604Please note that due to bugs in Xft, specifying alpha values might result
1605in garbage being displayed when the X-server does not support the RENDER
1606extension.
1607
1608=head1 ENVIRONMENT
1609
1610B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1611
1365=over 4 1612=over 4
1366 1613
1367=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1368
1369would yield White on Black, while on I<xterm>(1) it would yield Black
1370on White.
1371
1372=back
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
1396=head1 ENVIRONMENT
1397
1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1399
1400=over 4
1401
1402=item B<TERM> 1614=item B<TERM>
1403 1615
1404Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1616Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405resources or on the commandline. 1617resources or on the command line.
1406 1618
1407=item B<COLORTERM> 1619=item B<COLORTERM>
1408 1620
1409Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1621Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410compiled with XPM support, and optionally with the added extension 1622compiled with background image support, and optionally with the added
1411C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1623extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1624screen.
1412 1625
1413=item B<COLORFGBG> 1626=item B<COLORFGBG>
1414 1627
1415Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1628Set 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 1629the colour code used as default foreground/text colour (or the string
1417C<default> to indicate that the default-colour escape sequence is to be 1630C<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 1631used), 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@@ 1632string 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 1633was compiled with background image support. Libraries like C<ncurses>
1421(and do) use this information to optimize screen output. 1634and C<slang> can (and do) use this information to optimize screen output.
1422 1635
1423=item B<WINDOWID> 1636=item B<WINDOWID>
1424 1637
1425Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1638Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426window, which usually has subwindows for the scrollbar, the terminal 1639window, which usually has subwindows for the scrollbar, the terminal
1432C<--with-terminfo=PATH>. 1645C<--with-terminfo=PATH>.
1433 1646
1434=item B<DISPLAY> 1647=item B<DISPLAY>
1435 1648
1436Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1649Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437display in its child processes. 1650display in its child processes if C<-display> isn't used to override. It
1651defaults to C<:0> if it doesn't exist.
1438 1652
1439=item B<SHELL> 1653=item B<SHELL>
1440 1654
1441The shell to be used for command execution, defaults to C</bin/sh>. 1655The shell to be used for command execution, defaults to C</bin/sh>.
1442 1656
1443=item B<RXVT_SOCKET> 1657=item B<RXVT_SOCKET>
1444 1658
1445The unix domain socket path used by @@RXVT_NAME@@c(1) and 1659The unix domain socket path used by @@RXVT_NAME@@c(1) and
1446@@RXVT_NAME@@d(1). 1660@@RXVT_NAME@@d(1).
1447 1661
1448Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1662Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1449 1663
1450=item B<HOME> 1664=item B<HOME>
1451 1665
1452Used to locate the default directory for the unix domain socket for 1666Used to locate the default directory for the unix domain socket for
1453daemon communications and to locate various resource files (such as 1667daemon communications and to locate various resource files (such as
1454C<.Xdefaults>) 1668C<.Xdefaults>)
1455 1669
1456=item B<XAPPLRESDIR> 1670=item B<XAPPLRESDIR>
1457 1671
1458Directory where various X resource files are being located. 1672Directory where application-specific X resource files are located.
1459 1673
1460=item B<XENVIRONMENT> 1674=item B<XENVIRONMENT>
1461 1675
1462If set and accessible, gives the name of a X resource file to be loaded by 1676If set and accessible, gives the name of a X resource file to be loaded by
1463@@RXVT_NAME@@. 1677@@RXVT_NAME@@.
1468 1682
1469=over 4 1683=over 4
1470 1684
1471=item B</usr/lib/X11/rgb.txt> 1685=item B</usr/lib/X11/rgb.txt>
1472 1686
1473Color names. 1687Colour names.
1474 1688
1475=back 1689=back
1476 1690
1477=head1 SEE ALSO 1691=head1 SEE ALSO
1478 1692
1517Project Coordinator (changes.txt 2.21a to 2.4.5) 1731Project Coordinator (changes.txt 2.21a to 2.4.5)
1518 1732
1519=item Geoff Wing L<< <gcw@pobox.com> >> 1733=item Geoff Wing L<< <gcw@pobox.com> >>
1520 1734
1521Rewrote screen display and text selection routines. 1735Rewrote screen display and text selection routines.
1522 1736
1523Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1737Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1524 1738
1525=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1739=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1526 1740
1527Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1741Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1529 1743
1530Project Coordinator (Changes 1.0 -) 1744Project Coordinator (Changes 1.0 -)
1531 1745
1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1746=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533 1747
1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1748pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1535 1749
1536=back 1750=back
1537 1751

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines