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.117 by root, Fri Jul 28 09:14:10 2006 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 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<frills>: 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
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
103=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
104 117
105Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
106 119
107=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
108 121
109Turn on/off simulated reverse video; resource B<reverseVideo>. 122Turn on/off simulated reverse video; resource B<reverseVideo>.
110 123
111=item B<-j>|B<+j> 124=item B<-j>|B<+j>
112 125
113Turn on/off jump scrolling; resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 127
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 128=item B<-ss>|B<+ss>
116 129
117Turn on/off inheriting parent window's pixmap. Alternative form is 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
123 131
124=item B<-fade> I<number> 132=item B<-fade> I<number>
125 133
126Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
… …
130=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
131 139
132Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
133is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
134 142
135=item B<-tint> I<colour> 143=item B<-icon> I<file>
136 144
137Tint the transparent background pixmap with the given colour when 145Compile I<pixbuf>: Use the specified image as application icon. This
138transparency is enabled with B<-tr> or B<-ip>. This only works for 146is used by many window managers, taskbars and pagers to represent the
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 147application window; resource I<iconFile>.
140used to brighten or darken the image in addition to tinting it; resource
141I<tintColor>. Example:
142
143 @@RXVT_NAME@@ -tr -tint blue -sh 40
144
145=item B<-sh>
146
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be
149specified, too, e.g. C<-tint white>).
150 148
151=item B<-bg> I<colour> 149=item B<-bg> I<colour>
152 150
153Window background colour; resource B<background>. 151Window background colour; resource B<background>.
154 152
155=item B<-fg> I<colour> 153=item B<-fg> I<colour>
156 154
157Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
158
159=item B<-pixmap> I<file[;geom]>
160
161Compile I<XPM>: Specify XPM file for the background and also optionally
162specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>.
165 156
166=item B<-cr> I<colour> 157=item B<-cr> I<colour>
167 158
168The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
169 160
… …
214italic> >> characters are to be printed. See resource B<boldItalicFont> 205italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 206for details.
216 207
217=item B<-is>|B<+is> 208=item B<-is>|B<+is>
218 209
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
221details. 212details.
222 213
223=item B<-name> I<name> 214=item B<-name> I<name>
224 215
… …
242 233
243=item B<-sb>|B<+sb> 234=item B<-sb>|B<+sb>
244 235
245Turn on/off scrollbar; resource B<scrollBar>. 236Turn on/off scrollbar; resource B<scrollBar>.
246 237
238=item B<-sr>|B<+sr>
239
240Put scrollbar on right/left; resource B<scrollBar_right>.
241
242=item B<-st>|B<+st>
243
244Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
245resource B<scrollBar_floating>.
246
247=item B<-si>|B<+si> 247=item B<-si>|B<+si>
248 248
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 249Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 250B<scrollTtyOutput> has opposite effect.
251 251
… …
257=item B<-sw>|B<+sw> 257=item B<-sw>|B<+sw>
258 258
259Turn on/off scrolling with the scrollback buffer as new lines appear. 259Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 260This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 261B<scrollWithBuffer>.
262
263=item B<-sr>|B<+sr>
264
265Put scrollbar on right/left; resource B<scrollBar_right>.
266
267=item B<-st>|B<+st>
268
269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270resource B<scrollBar_floating>.
271 262
272=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
273 264
274If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 266actual wide characters in the screen buffer, which makes it possible to
… …
279 270
280=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
281 272
282Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
283 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
284=item B<-iconic> 279=item B<-iconic>
285 280
286Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
287Alternative form is B<-ic>. 282Alternative form is B<-ic>.
288 283
… …
304 299
305=item B<-bl> 300=item B<-bl>
306 301
307Compile I<frills>: Set MWM hints to request a borderless window, i.e. 302Compile I<frills>: Set MWM hints to request a borderless window, i.e.
308if honoured by the WM, the rxvt-unicode window will not have window 303if honoured by the WM, the rxvt-unicode window will not have window
309decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
310 306
311=item B<-override-redirect> 307=item B<-override-redirect>
312 308
313Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>. 310B<override-redirect>.
… …
322 318
323=item B<-lsp> I<number> 319=item B<-lsp> I<number>
324 320
325Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
327B<linespace>. 323B<lineSpace>.
324
325=item B<-letsp> I<number>
326
327Compile I<frills>: Amount to adjust the computed character width by
328to control overall letter spacing. Negative values will tighten up the
329letter spacing, positive values will space letters out more. Useful to
330work around odd font metrics; resource B<letterSpace>.
328 331
329=item B<-tn> I<termname> 332=item B<-tn> I<termname>
330 333
331This option specifies the name of the terminal type to be set in the 334This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
… …
386for more info. 389for more info.
387 390
388=item B<-tcw> 391=item B<-tcw>
389 392
390Change the meaning of triple-click selection with the left mouse 393Change the meaning of triple-click selection with the left mouse
394button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 395in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 396the end of the logical line only. resource B<tripleclickwords>.
393 397
394=item B<-insecure> 398=item B<-insecure>
395 399
396Enable "insecure" mode, which currently enables most of the escape 400Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 401sequences that echo strings. See the resource B<insecure> for more
… …
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 423will not immediately destroy its window when the program executed within
420it exits. Instead, it will wait till it is being killed or closed by the 424it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 425user; resource B<hold>.
422 426
427=item B<-cd> I<path>
428
429Sets the working directory for the shell (or the command specified via
430B<-e>). The I<path> must be an absolute path and it must exist for
431@@RXVT_NAME@@ to start; resource B<chdir>.
432
433=item B<-xrm> I<string>
434
435Works like the X Toolkit option of the same name, by adding the I<string>
436as if it were specified in a resource file. Resource values specified this
437way take precedence over all other resource specifications.
438
439Note that you need to use the I<same> syntax as in the .Xdefaults file,
440e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
441options can be specified as long-options on the commandline, so use
442of B<-xrm> is mostly limited to cases where you want to specify other
443resources (e.g. for input methods) or for compatibility with other
444programs.
445
423=item B<-keysym.>I<sym> I<string> 446=item B<-keysym.>I<sym> I<string>
424 447
425Remap a key symbol. See resource B<keysym>. 448Remap a key symbol. See resource B<keysym>.
426 449
427=item B<-embed> I<windowid> 450=item B<-embed> I<windowid>
… …
437The window will not be destroyed when @@RXVT_NAME@@ exits. 460The window will not be destroyed when @@RXVT_NAME@@ exits.
438 461
439It might be useful to know that @@RXVT_NAME@@ will not close file 462It might be useful to know that @@RXVT_NAME@@ will not close file
440descriptors passed to it (except for stdin/out/err, of course), so you 463descriptors passed to it (except for stdin/out/err, of course), so you
441can use file descriptors to communicate with the programs within the 464can use file descriptors to communicate with the programs within the
442terminal. This works regardless of wether the C<-embed> option was used or 465terminal. This works regardless of whether the C<-embed> option was used or
443not. 466not.
444 467
445Here is a short Gtk2-perl snippet that illustrates how this option can be 468Here is a short Gtk2-perl snippet that illustrates how this option can be
446used (a longer example is in F<doc/embed>): 469used (a longer example is in F<doc/embed>):
447 470
… …
452 }); 475 });
453 476
454=item B<-pty-fd> I<file descriptor> 477=item B<-pty-fd> I<file descriptor>
455 478
456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 479Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
457pair but instead use the given filehandle as the tty master. This is 480pair but instead use the given file descriptor as the tty master. This is
458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 481useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
459without having to run a program within it. 482without having to run a program within it.
460 483
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 484If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that 485entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 486yourself if you want that.
464 487
465As an extremely special case, specifying C<-1> will completely suppress 488As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 489pty/tty operations, which is probably only useful in conjunction with some
490perl extension that manages the terminal.
467 491
468Here is a example in perl that illustrates how this option can be used (a 492Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 493longer example is in F<doc/pty-fd>):
470 494
471 use IO::Pty; 495 use IO::Pty;
… …
485Comma-separated list of perl extension scripts to use (or not to use) in 509Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 510this terminal instance. See resource B<perl-ext> for details.
487 511
488=back 512=back
489 513
490=head1 RESOURCES (available also as long-options) 514=head1 RESOURCES
491 515
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 516Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 517options) compiled into your version. All resources are also available as
518long-options.
494 519
495You can set and change the resources using X11 tools like B<xrdb>. Many 520You can set and change the resources using X11 tools like B<xrdb>. Many
496distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
499 524
500 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
503 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
530 6. resources specified via -xrm on the commandline
505 531
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 534common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 535configured, while the class name B<URxvt> allows resources unique to
… …
519=item B<depth:> I<bitdepth> 545=item B<depth:> I<bitdepth>
520 546
521Compile I<xft>: Attempt to find a visual with the given bit depth; 547Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>. 548option B<-depth>.
523 549
550=item B<buffered:> I<boolean>
551
552Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
553On some card/driver combination enabling it slightly decreases
554performance, on most it greatly helps it. The slowdown is small, so it
555should normally be enabled.
556
524=item B<geometry:> I<geom> 557=item B<geometry:> I<geom>
525 558
526Create the window with the specified X window geometry [default 80x24]; 559Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 560option B<-geometry>.
528 561
… …
541Use the specified colour for the colour value I<n>, where 0-7 574Use the specified colour for the colour value I<n>, where 0-7
542corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
543high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
544colours. The canonical names are as follows: 0=black, 1=red, 2=green, 577colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5453=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5783=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
546names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
547 580
548Colours higher than 15 cannot be set using resources (yet), but can be 581Colours higher than 15 cannot be set using resources (yet), but can be
549changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
550 583
551Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 584Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
562=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
563 596
564Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
565foreground colour is the default. 598foreground colour is the default.
566 599
567=item B<colorRV:> I<colour>
568
569Use the specified colour as the background for reverse video
570characters.
571
572=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
573 601
574If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 603itself. If unset, use the foreground colour.
604
605=item B<highlightColor:> I<colour>
606
607If set, use the specified colour as the background for highlighted
608characters. If unset, use reverse video.
609
610=item B<highlightTextColor:> I<colour>
611
612If set and highlightColor is set, use the specified colour as the
613foreground for highlighted characters.
576 614
577=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
578 616
579Use the specified colour for the cursor. The default is to use the 617Use the specified colour for the cursor. The default is to use the
580foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
… …
587 625
588=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
589 627
590B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
591option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593 631
594=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
595 633
596B<True>: specify that jump scrolling should be used. When scrolling 634B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 635of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
636has been read, resulting in fewer updates while still displaying every
637received line; option B<-j>.
638
598B<False>: specify that smooth scrolling should be used; option B<+j>. 639B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
640force a screen refresh on each new line it received; option B<+j>.
599 641
600=item B<inheritPixmap:> I<boolean> 642=item B<skipScroll:> I<boolean>
601 643
602B<True>: make the background inherit the parent windows' pixmap, giving 644B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 645receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 646(around 60 times per second), resulting in far fewer updates. This can
647result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
648option B<-ss>.
605 649
606I<Please note that transparency of any kind if completely unsupported by 650B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 651if the refresh is too fast for the human eye to read anything (or the
652monitor to display anything); option B<+ss>.
608 653
609=item B<fading:> I<number> 654=item B<fading:> I<number>
610 655
611Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
612 657
613=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
614 659
615Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
616colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
617 662
618=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
619 664
620Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
621B<-tint>.
622
623=item B<shading:> I<number>
624
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
626image in addition to tinting it.
627 666
628=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
629 668
630Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
631 670
… …
636 675
637=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
638 677
639The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
640and the text. 679and the text.
641
642=item B<backgroundPixmap:> I<file[;geom]>
643
644Use the specified XPM file (note the `.xpm' extension is optional) for
645the background and also optionally specify its scaling with a geometry
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale
649of 1 displays the image without any scaling. A scale of 2 to 9
650specifies an integer number of images in that direction. No image will
651be magnified beyond 10 times its original size. The maximum permitted
652scale is 1000. [default 0x0+50+50]
653
654=item B<path:> I<path>
655
656Specify the colon-delimited search path for finding XPM files.
657 680
658=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
659 682
660Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
661that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
… …
684it is named first) and thus defines the character cell grid to be 9 pixels 707it is named first) and thus defines the character cell grid to be 9 pixels
685wide and 15 pixels high. 708wide and 15 pixels high.
686 709
687The second font is just used to add additional unicode characters not in 710The second font is just used to add additional unicode characters not in
688the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
689the bold version of the font does contain less characters, so this is a 712the bold version of the font does contain fewer characters, so this is a
690useful supplement. 713useful supplement.
691 714
692The third font is an Xft font with aliasing turned off, and the characters 715The third font is an Xft font with aliasing turned off, and the characters
693are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 716are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
… …
718text font will being used for the given style. 741text font will being used for the given style.
719 742
720=item B<intensityStyles:> I<boolean> 743=item B<intensityStyles:> I<boolean>
721 744
722When font styles are not enabled, or this option is enabled (B<True>, 745When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 746option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/backround colours. Disabling this option (B<False>, 747intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 748option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 749reachable.
727
728=item B<selectstyle:> I<mode>
729
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731xterm style with 2.20 old word selection, or anything else which gives
732xterm style selection.
733
734=item B<scrollstyle:> I<mode>
735
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite.
738 750
739=item B<title:> I<string> 751=item B<title:> I<string>
740 752
741Set window title string, the default title is the command-line 753Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 754specified after the B<-e> option, if any, otherwise the application
… …
751=item B<mapAlert:> I<boolean> 763=item B<mapAlert:> I<boolean>
752 764
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 765B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 766de-iconify (map) on receipt of a bell character [default].
755 767
768=item B<urgentOnBell:> I<boolean>
769
770B<True>: set the urgency hint for the wm on receipt of a bell character.
771B<False>: do not set the urgency hint [default].
772
773@@RXVT_NAME@@ resets the urgency hint on every focus change.
774
756=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
757 776
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 777B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
760 779
… …
781Example: 800Example:
782 801
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 802 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 803
785This creates a new file in your home directory with the screen contents 804This creates a new file in your home directory with the screen contents
786everytime you hit C<Print>. 805every time you hit C<Print>.
806
807=item B<scrollstyle:> I<mode>
808
809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
810the author's favourite.
811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
787 815
788=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
789 817
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
… …
811B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
812B<+si>. 840B<+si>.
813 841
814=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
815 843
816B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
818with scrollback buffer when tty recieves new lines; option B<+sw>. 846B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
847new lines; option B<+sw>.
819 848
820=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
821 850
822B<True>: scroll to bottom when a non-special key is pressed. Special keys 851B<True>: scroll to bottom when a non-special key is pressed. Special keys
823are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
854=item B<termName:> I<termname> 883=item B<termName:> I<termname>
855 884
856Specifies the terminal type name to be set in the B<TERM> environment 885Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 886variable; option B<-tn>.
858 887
859=item B<linespace:> I<number> 888=item B<lineSpace:> I<number>
860 889
861Specifies number of lines (pixel height) to insert between each row of 890Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 891the display [default 0]; option B<-lsp>.
863 892
864=item B<meta8:> I<boolean> 893=item B<meta8:> I<boolean>
… …
878 907
879=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
880 909
881B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 910B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882option B<-bc>. 911option B<-bc>.
912
913=item B<cursorUnderline:> I<boolean>
914
915B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
916option B<-uc>.
883 917
884=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
885 919
886B<True>: blank the pointer when a key is pressed or after a set number 920B<True>: blank the pointer when a key is pressed or after a set number
887of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
… …
901large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
902 936
903=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
904 938
905The string to send when the backspace key is pressed. If set to B<DEC> 939The string to send when the backspace key is pressed. If set to B<DEC>
906or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 940or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
907(code 8) - which can be reversed with the appropriate DEC private mode 941(code 8) - which can be reversed with the appropriate DEC private mode
908escape sequence. 942escape sequence.
909 943
910=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
911 945
… …
916=item B<cutchars:> I<string> 950=item B<cutchars:> I<string>
917 951
918The characters used as delimiters for double-click word selection 952The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 953(whitespace delimiting is added automatically if resource is given).
920 954
921When the selection extension is in use (the default if compiled in, see 955When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 956in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 957characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 958will be created). In this mode, characters outside ISO-8859-1 can be used.
925 959
926When the selection extension is not used, only ISO-8859-1 characters can 960When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 961be used. If not specified, the built-in default is used:
928 962
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 964
931=item B<preeditType:> I<style> 965=item B<preeditType:> I<style>
932 966
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 968
… …
988 1022
989Turn on/off secondary screen (default enabled). 1023Turn on/off secondary screen (default enabled).
990 1024
991=item B<secondaryScroll:> I<boolean> 1025=item B<secondaryScroll:> I<boolean>
992 1026
993Turn on/off secondary screen scroll (default enabled). If the this 1027Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
997 1031
998=item B<hold>: I<boolean> 1032=item B<hold>: I<boolean>
999 1033
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the 1036it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1037user.
1038
1039=item B<chdir>: I<path>
1040
1041Sets the working directory for the shell (or the command specified via
1042B<-e>). The I<path> must be an absolute path and it must exist for
1043@@RXVT_NAME@@ to start. If it isn't specified then the current working
1044directory will be used; option B<-cd>.
1004 1045
1005=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<string>
1006 1047
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008intervening resource name B<keysym.> cannot be omitted. 1049intervening resource name B<keysym.> cannot be omitted.
… …
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1063searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1064omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1065keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1026 1067
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1069number), see RESOURCES in C<man 7 X> for further details.
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace.
1032 1070
1033Please note that you need to double the C<\> in resource files, as
1034Xlib itself does its own de-escaping (you can use C<\033> instead of
1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036processing).
1037
1038You can define a range of keysyms in one shot by providing a I<string> 1071You can define a range of keysyms in one shot by
1072loading the C<keysym-list> perl extension and providing a I<string>
1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040should be a character not used by the strings. 1074should be a character not used by the strings.
1041 1075
1042Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1043 1077
1044 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1045 1079
1046The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1047 1081
1048 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1049 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1050 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1051 1085
1052If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1086If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1053is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1054example the following means "change the current locale to C<zh_CN.GBK> 1088example the following means "change the current locale to C<zh_CN.GBK>
1055when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
1056 1090
1057 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1091 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058 1092
1059If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1093If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1060is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1094is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1061manpage. For example, the F<selection> extension (activated via 1095manpage. For example, the F<selection> extension (activated via
1062C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063 1097
1064 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1065 1099
1066Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1067will match if at I<at least> the specified identifiers are being set, and 1101will match if I<at least> the specified identifiers are being set, and
1068no other key mappings with those and more bits are being defined. That 1102no other key mappings with those and more bits are being defined. That
1069means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1070definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1104definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071mappings themselves. 1105mappings themselves.
1072 1106
… …
1108example, C<default,-selection> will use all the default extension except 1142example, C<default,-selection> will use all the default extension except
1109C<selection>. 1143C<selection>.
1110 1144
1111Extension names can also be followed by an argument in angle brackets 1145Extension names can also be followed by an argument in angle brackets
1112(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1146(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1113searchable scorllback to Alt/Meta-s). Mentioning the same extension 1147searchable scrollback to Alt/Meta-s). Mentioning the same extension
1114multiple times with different arguments will pass multiple arguments to 1148multiple times with different arguments will pass multiple arguments to
1115the extension. 1149the extension.
1116 1150
1117Each extension is looked up in the library directories, loaded if 1151Each extension is looked up in the library directories, loaded if
1118necessary, and bound to the current terminal instance. 1152necessary, and bound to the current terminal instance.
… …
1123all instances, while B<perl-ext> is used for specific instances. 1157all instances, while B<perl-ext> is used for specific instances.
1124 1158
1125=item B<perl-eval>: I<string> 1159=item B<perl-eval>: I<string>
1126 1160
1127Perl code to be evaluated when all extensions have been registered. See 1161Perl code to be evaluated when all extensions have been registered. See
1128the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1162the @@RXVT_NAME@@perl(3) manpage.
1129will be ignored when running setuid/setgid.
1130 1163
1131=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1132 1165
1133Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1134scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1135@@RXVT_NAME@@ will first look in these directories and then in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1136F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137will be ignored when running setuid/setgid.
1138 1170
1139See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1140 1172
1141=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142 1174
… …
1151=item B<searchable-scrollback:> I<keysym> 1183=item B<searchable-scrollback:> I<keysym>
1152 1184
1153Sets the hotkey that starts the incremental scrollback buffer search 1185Sets the hotkey that starts the incremental scrollback buffer search
1154(default: C<M-s>). 1186(default: C<M-s>).
1155 1187
1156=item B<urlLauncher>: I<string> 1188=item B<url-launcher>: I<string>
1157 1189
1158Specifies the program to be started with a URL argument. Used by the 1190Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1160 1192
1161=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
1162 1194
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1195Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164 1196
1165=item B<override-redirect>: I<boolean> 1197=item B<override-redirect>: I<boolean>
1166 1198
1167Compile I<frills>: Sets override-redirect for the terminal window, making 1199Compile I<frills>: Sets override-redirect for the terminal window, making
1168it almost invisible to window managers; option B<-override-redirect>. 1200it almost invisible to window managers; option B<-override-redirect>.
1201
1202=item B<iso14755:> I<boolean>
1203
1204Turn on/off ISO 14755 (default enabled).
1205
1206=item B<iso14755_52:> I<boolean>
1207
1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=back
1211
1212=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1213
1214=over 4
1215
1216=item B<-pixmap> I<file[;oplist]>
1217
1218=item B<backgroundPixmap:> I<file[;oplist]>
1219
1220Compile I<pixbuf>: Use the specified image file as the window's
1221background and also optionally specify a colon separated list of
1222operations to modify it. Note that you may need to quote the C<;>
1223character when using the command line option, as C<;> is usually a
1224metacharacter in shells. Supported operations are:
1225
1226=over 4
1227
1228=item B<WxH+X+Y>
1229
1230sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1231scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1232scale of 0 disables scaling.
1233
1234=item B<op=tile>
1235
1236enables tiling
1237
1238=item B<op=keep-aspect>
1239
1240maintain the image aspect ratio when scaling
1241
1242=item B<op=root-align>
1243
1244use the position of the terminal window relative to the root window as
1245the image offset, simulating a root window background
1246
1247=back
1248
1249The default scale and position setting is C<100x100+50+50>.
1250Alternatively, a predefined set of templates can be used to achieve
1251the most common setups:
1252
1253=over 4
1254
1255=item B<style=tiled>
1256
1257the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1258
1259=item B<style=aspect-stretched>
1260
1261the image is scaled to fill the whole window maintaining the aspect
1262ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1263
1264=item B<style=stretched>
1265
1266the image is scaled to fill the whole window. Equivalent to 100x100
1267
1268=item B<style=centered>
1269
1270the image is centered with no scaling. Equivalent to 0x0+50+50
1271
1272=item B<style=root-tiled>
1273
1274the image is tiled with no scaling and using 'root' positioning.
1275Equivalent to 0x0:op=tile:op=root-align
1276
1277=back
1278
1279If multiple templates are specified the last one wins. Note that a
1280template overrides all the scale, position and operations settings.
1281
1282If used in conjunction with pseudo-transparency, the specified pixmap
1283will be blended over the transparent background using alpha-blending.
1284
1285=item B<-tr>|B<+tr>
1286
1287=item B<transparent:> I<boolean>
1288
1289Turn on/off pseudo-transparency by using the root pixmap as background.
1290
1291B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1292will be removed in future versions.
1293
1294=item B<-tint> I<colour>
1295
1296=item B<tintColor:> I<colour>
1297
1298Tint the transparent background with the given colour. Note that a
1299black tint yields a completely black image while a white tint yields
1300the image unchanged.
1301
1302=item B<-sh> I<number>
1303
1304=item B<shading:> I<number>
1305
1306Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1307A value of 100 means no shading.
1308
1309=item B<-blr> I<HxV>
1310
1311=item B<blurRadius:> I<HxV>
1312
1313Apply gaussian blur with the specified radius to the transparent
1314background. If a single number is specified, the vertical and
1315horizontal radii are considered to be the same. Setting one of the
1316radii to 1 and the other to a large number creates interesting effects
1317on some backgrounds. The maximum radius value is 128. An horizontal or
1318vertical radius of 0 disables blurring.
1319
1320=item B<path:> I<path>
1321
1322Specify the colon-delimited search path for finding background image files.
1169 1323
1170=back 1324=back
1171 1325
1172=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1173 1327
… …
1192application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1346application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1347(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1348up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195respectively. 1349respectively.
1196 1350
1197=head1 TEXT SELECTION AND INSERTION 1351=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198 1352
1199The behaviour of text selection and insertion mechanism is similar to 1353The behaviour of text selection and insertion/pasting mechanism is similar
1200I<xterm>(1). 1354to I<xterm>(1).
1201 1355
1202=over 4 1356=over 4
1203 1357
1204=item B<Selection>: 1358=item B<Selecting>:
1205 1359
1206Left click at the beginning of the region, drag to the end of the region 1360Left click at the beginning of the region, drag to the end of the region
1207and release; Right click to extend the marked region; Left double-click 1361and release; Right click to extend the marked region; Left double-click
1208to select a word; Left triple-click to select the entire logical line 1362to select a word; Left triple-click to select the entire logical line
1209(which can span multiple screen lines), unless modified by resource 1363(which can span multiple screen lines), unless modified by resource
… …
1213(Compile: I<frills>) will create a rectangular selection instead of a 1367(Compile: I<frills>) will create a rectangular selection instead of a
1214normal one. In this mode, every selected row becomes its own line in the 1368normal one. In this mode, every selected row becomes its own line in the
1215selection, and trailing whitespace is visually underlined and removed from 1369selection, and trailing whitespace is visually underlined and removed from
1216the selection. 1370the selection.
1217 1371
1218=item B<Insertion>: 1372=item B<Pasting>:
1219 1373
1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1374Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221window causes the value of the PRIMARY selection (or CLIPBOARD with the 1375window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222Meta modifier) to be inserted as if it had been typed on the keyboard. 1376B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223 1377
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1378Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too. 1379inserted too.
1226 1380
1227=back 1381=back
… …
1244 1398
1245=head1 ISO 14755 SUPPORT 1399=head1 ISO 14755 SUPPORT
1246 1400
1247ISO 14755 is a standard for entering and viewing unicode characters 1401ISO 14755 is a standard for entering and viewing unicode characters
1248and character codes using the keyboard. It consists of 4 parts. The 1402and character codes using the keyboard. It consists of 4 parts. The
1249first part is available rxvt-unicode has been compiled with 1403first part is available if rxvt-unicode has been compiled with
1250C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1404C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251with C<--enable-iso14755>. 1405with C<--enable-iso14755>.
1252 1406
1253=over 4 1407=over 4
1254 1408
… …
1312B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1466B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1313it can be seen via the I<who(1)> command, and can accept messages. To 1467it can be seen via the I<who(1)> command, and can accept messages. To
1314allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1468allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1315on some systems or setgid to root or to some other group on others. 1469on some systems or setgid to root or to some other group on others.
1316 1470
1317=head1 COLORS AND GRAPHICS 1471=head1 COLOURS AND GRAPHICS
1318 1472
1319In addition to the default foreground and background colours, 1473In addition to the default foreground and background colours,
1320B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1474B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1321high-intensity bold/blink versions of the same). Here is a list of the 1475high-intensity (potentially bold/blink) versions of the same, and 72 (or
1322colours with their names. 1476240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1477cube plus a 8 (24) colour greyscale ramp.
1478
1479Here is a list of the ANSI colours with their names.
1323 1480
1324=begin table 1481=begin table
1325 1482
1326 B<color0> (black) = Black 1483 B<color0> (black) = Black
1327 B<color1> (red) = Red3 1484 B<color1> (red) = Red3
… …
1347It is also possible to specify the colour values of B<foreground>, 1504It is also possible to specify the colour values of B<foreground>,
1348B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1505B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1349a number 0-15, as a convenient shorthand to reference the colour name of 1506a number 0-15, as a convenient shorthand to reference the colour name of
1350color0-color15. 1507color0-color15.
1351 1508
1352In addition to the colours defined above, @@RXVT_NAME@@ offers an 1509The following text gives values for the standard 88 colour mode (and
1353additional 72 colours. The first 64 of those (with indices 16 to 79) 1510values for the 256 colour mode in parentheses).
1354consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135516>), followed by 8 additional shades of gray (with indices 80 to 87).
1356 1511
1512The RGB cube uses indices 16..79 (16..231) using the following formulas:
1513
1514 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1515 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1516
1517The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1518steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1519the RGB cube.
1520
1357Together, all those colours implement the 88 colour xterm colours. Only 1521Together, all those colours implement the 88 (256) colour xterm
1358the first 16 can be changed using resources currently, the rest can only 1522colours. Only the first 16 can be changed using resources currently, the
1359be changed via command sequences ("escape codes"). 1523rest can only be changed via command sequences ("escape codes").
1524
1525Applications are advised to use terminfo or command sequences to discover
1526number and RGB values of all colours (yes, you can query this...).
1360 1527
1361Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1528Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362always swapping the foreground/background colours. This is in contrast to 1529always swapping the foreground/background colours. This is in contrast to
1363I<xterm>(1) where the colours are only swapped if they have not otherwise 1530I<xterm>(1) where the colours are only swapped if they have not otherwise
1364been specified. For example, 1531been specified. For example,
1365 1532
1533 @@RXVT_NAME@@ -fg Black -bg White -rv
1534
1535would yield White on Black, while on I<xterm>(1) it would yield Black on
1536White.
1537
1538=head2 ALPHA CHANNEL SUPPORT
1539
1540If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1541their act together, rxvt-unicode will do its own alpha channel management:
1542
1543You can prefix any colour with an opaqueness percentage enclosed in
1544brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1545(0-100) that specifies the opacity of the colour, where C<0> is completely
1546transparent and C<100> is completely opaque. For example, C<[50]red> is a
1547half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1548is the recommended format to specify transparency values, and works with
1549all ways to specify a colour.
1550
1551For complete control, rxvt-unicode also supports
1552C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1553specifications, where the additional C<aaaa> component specifies opacity
1554(alpha) values. The minimum value of C<0000> is completely transparent,
1555while C<ffff> is completely opaque). The two example colours from
1556earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1557C<rgba:0000/ff00/0000/f332>.
1558
1559You probably need to specify B<"-depth 32">, too, to force a visual with
1560alpha channels, and have the luck that your X-server uses ARGB pixel
1561layout, as X is far from just supporting ARGB visuals out of the box, and
1562rxvt-unicode just fudges around.
1563
1564For example, the following selects an almost completely transparent black
1565background, and an almost opaque pink foreground:
1566
1567 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1568
1569When not using a background image, then the interpretation of the
1570alpha channel is up to your compositing manager (most interpret it as
1571transparency of course).
1572
1573When using a background pixmap or pseudo-transparency, then the background
1574colour will always behave as if it were completely transparent (so the
1575background image shows instead), regardless of how it was specified, while
1576other colours will either be transparent as specified (the background
1577image will show through) on servers supporting the RENDER extension, or
1578fully opaque on servers not supporting the RENDER EXTENSION.
1579
1580Please note that due to bugs in Xft, specifying alpha values might result
1581in garbage being displayed when the X-server does not support the RENDER
1582extension.
1583
1584=head1 ENVIRONMENT
1585
1586B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1587
1366=over 4 1588=over 4
1367 1589
1368=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1369
1370would yield White on Black, while on I<xterm>(1) it would yield Black
1371on White.
1372
1373=back
1374
1375=head2 ALPHA CHANNEL SUPPORT
1376
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1379(recommended, but B<MUST> have 4 digits/component) colour specifications,
1380in addition to the ones provided by X, where the additional A component
1381specifies opacity (alpha) values. The minimum value of C<0> is completely
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on
1383to four hex digits specifiying the opacity value.
1384
1385You probably need to specify B<"-depth 32">, too, and have the luck that
1386your X-server uses ARGB pixel layout, as X is far from just supporting
1387ARGB visuals out of the box, and rxvt-unicode just fudges around.
1388
1389For example, the following selects an almost completely transparent red
1390background, and an almost opaque pink foreground:
1391
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1393
1394I<Please note that transparency of any kind if completely unsupported by
1395the author. Don't bug him with installation questions!>
1396
1397=head1 ENVIRONMENT
1398
1399B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400
1401=over 4
1402
1403=item B<TERM> 1590=item B<TERM>
1404 1591
1405Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1592Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1406resources or on the commandline. 1593resources or on the command line.
1407 1594
1408=item B<COLORTERM> 1595=item B<COLORTERM>
1409 1596
1410Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1597Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411compiled with XPM support, and optionally with the added extension 1598compiled with background image support, and optionally with the added
1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1599extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1600screen.
1413 1601
1414=item B<COLORFGBG> 1602=item B<COLORFGBG>
1415 1603
1416Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1604Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417the colour code used as default foreground/text colour (or the string 1605the colour code used as default foreground/text colour (or the string
1418C<default> to indicate that the default-colour escape sequence is to be 1606C<default> to indicate that the default-colour escape sequence is to be
1419used), C<bg> is the colour code used as default background colour (or the 1607used), C<bg> is the colour code used as default background colour (or the
1420string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1608string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1609was compiled with background image support. Libraries like C<ncurses>
1422(and do) use this information to optimize screen output. 1610and C<slang> can (and do) use this information to optimize screen output.
1423 1611
1424=item B<WINDOWID> 1612=item B<WINDOWID>
1425 1613
1426Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1614Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427window, which usually has subwindows for the scrollbar, the terminal 1615window, which usually has subwindows for the scrollbar, the terminal
… …
1433C<--with-terminfo=PATH>. 1621C<--with-terminfo=PATH>.
1434 1622
1435=item B<DISPLAY> 1623=item B<DISPLAY>
1436 1624
1437Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1625Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438display in its child processes. 1626display in its child processes if C<-display> isn't used to override. It
1627defaults to C<:0> if it doesn't exist.
1439 1628
1440=item B<SHELL> 1629=item B<SHELL>
1441 1630
1442The shell to be used for command execution, defaults to C</bin/sh>. 1631The shell to be used for command execution, defaults to C</bin/sh>.
1443 1632
1444=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1445 1634
1446The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1447@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1448 1637
1449Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1638Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1639
1640=item B<URXVT_PERL_LIB>
1641
1642Additional F<:>-separated library search path for perl extensions. Will be
1643searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1644directory.
1645
1646=item B<URXVT_PERL_VERBOSITY>
1647
1648See L<@@RXVT_NAME@@perl>(3).
1450 1649
1451=item B<HOME> 1650=item B<HOME>
1452 1651
1453Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1454daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
1455C<.Xdefaults>) 1654C<.Xdefaults>)
1456 1655
1457=item B<XAPPLRESDIR> 1656=item B<XAPPLRESDIR>
1458 1657
1459Directory where various X resource files are being located. 1658Directory where application-specific X resource files are located.
1460 1659
1461=item B<XENVIRONMENT> 1660=item B<XENVIRONMENT>
1462 1661
1463If set and accessible, gives the name of a X resource file to be loaded by 1662If set and accessible, gives the name of a X resource file to be loaded by
1464@@RXVT_NAME@@. 1663@@RXVT_NAME@@.
… …
1469 1668
1470=over 4 1669=over 4
1471 1670
1472=item B</usr/lib/X11/rgb.txt> 1671=item B</usr/lib/X11/rgb.txt>
1473 1672
1474Color names. 1673Colour names.
1475 1674
1476=back 1675=back
1477 1676
1478=head1 SEE ALSO 1677=head1 SEE ALSO
1479 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1480@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1680@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1481 1681
1482=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1483 1683
1484=over 4 1684=over 4
1485 1685
1486=item Project Coordinator 1686=item Project Coordinator
1487 1687
1488Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1489 1689
1490L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1690L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1491 1691
1492=back 1692=back
1493 1693
… …
1497 1697
1498=item John Bovey 1698=item John Bovey
1499 1699
1500University of Kent, 1992, wrote the original Xvt. 1700University of Kent, 1992, wrote the original Xvt.
1501 1701
1502=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1702=item Rob Nation <nation@rocket.sanders.lockheed.com>
1503 1703
1504very heavily modified Xvt and came up with Rxvt 1704very heavily modified Xvt and came up with Rxvt
1505 1705
1506=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1706=item Angelo Haritsis <ah@doc.ic.ac.uk>
1507 1707
1508wrote the Greek Keyboard Input (no longer in code) 1708wrote the Greek Keyboard Input (no longer in code)
1509 1709
1510=item mj olesen L<< <olesen@me.QueensU.CA> >> 1710=item mj olesen <olesen@me.QueensU.CA>
1511 1711
1512Wrote the menu system. 1712Wrote the menu system.
1513 1713
1514Project Coordinator (changes.txt 2.11 to 2.21) 1714Project Coordinator (changes.txt 2.11 to 2.21)
1515 1715
1516=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1716=item Oezguer Kesim <kesim@math.fu-berlin.de>
1517 1717
1518Project Coordinator (changes.txt 2.21a to 2.4.5) 1718Project Coordinator (changes.txt 2.21a to 2.4.5)
1519 1719
1520=item Geoff Wing L<< <gcw@pobox.com> >> 1720=item Geoff Wing <gcw@pobox.com>
1521 1721
1522Rewrote screen display and text selection routines. 1722Rewrote screen display and text selection routines.
1523 1723
1524Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1724Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525 1725
1526=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1726=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1527 1727
1528Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1728Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1529extension, random hacks, numerous bugfixes and extensions. 1729extension, random hacks, numerous bugfixes and extensions.
1530 1730
1531Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1532 1732
1533=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1733=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1534 1734
1535Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1536 1736
1537=back 1737=back
1538 1738

Diff Legend

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