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.115 by root, Mon Jul 10 04:01:33 2006 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 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
47programs force onto its users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51its predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of its features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
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<-blr> I<HxV>
156
157Apply Gaussian Blur with the specified radii to the transparent
158background. If a single number is specified, the vertical and
159horizontal radii are considered to be the same. Setting one of the
160radii to 1 and the other to a large number creates interesting effects
161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
163resource I<blurRadius>.
164
165=item B<-icon> I<file>
166
167Compile I<pixbuf>: Use the specified image as application icon. This
168is used by many window managers, taskbars and pagers to represent the
169application window; resource I<iconFile>.
149 170
150=item B<-bg> I<colour> 171=item B<-bg> I<colour>
151 172
152Window background colour; resource B<background>. 173Window background colour; resource B<background>.
153 174
154=item B<-fg> I<colour> 175=item B<-fg> I<colour>
155 176
156Window foreground colour; resource B<foreground>. 177Window foreground colour; resource B<foreground>.
157 178
158=item B<-pixmap> I<file[;geom]> 179=item B<-pixmap> I<file[;oplist]>
159 180
160Compile I<XPM>: Specify XPM file for the background and also optionally 181Compile I<pixbuf>: Specify image file for the background and also
161specify its scaling with a geometry string. Note you may need to 182optionally 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 183add quotes to avoid special shell interpretation of the C<;> in the
163command-line; resource B<backgroundPixmap>. 184command-line; for more details see resource B<backgroundPixmap>.
164 185
165=item B<-cr> I<colour> 186=item B<-cr> I<colour>
166 187
167The cursor colour; resource B<cursorColor>. 188The cursor colour; resource B<cursorColor>.
168 189
213italic> >> characters are to be printed. See resource B<boldItalicFont> 234italic> >> characters are to be printed. See resource B<boldItalicFont>
214for details. 235for details.
215 236
216=item B<-is>|B<+is> 237=item B<-is>|B<+is>
217 238
218Compile I<font-styles>: Bold/Italic font styles imply high intensity 239Compile I<font-styles>: Bold/Blink font styles imply high intensity
219foreground/background (default). See resource B<intensityStyles> for 240foreground/background (default). See resource B<intensityStyles> for
220details. 241details.
221 242
222=item B<-name> I<name> 243=item B<-name> I<name>
223 244
241 262
242=item B<-sb>|B<+sb> 263=item B<-sb>|B<+sb>
243 264
244Turn on/off scrollbar; resource B<scrollBar>. 265Turn on/off scrollbar; resource B<scrollBar>.
245 266
267=item B<-sr>|B<+sr>
268
269Put scrollbar on right/left; resource B<scrollBar_right>.
270
271=item B<-st>|B<+st>
272
273Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
274resource B<scrollBar_floating>.
275
246=item B<-si>|B<+si> 276=item B<-si>|B<+si>
247 277
248Turn on/off scroll-to-bottom on TTY output inhibit; resource 278Turn on/off scroll-to-bottom on TTY output inhibit; resource
249B<scrollTtyOutput> has opposite effect. 279B<scrollTtyOutput> has opposite effect.
250 280
256=item B<-sw>|B<+sw> 286=item B<-sw>|B<+sw>
257 287
258Turn on/off scrolling with the scrollback buffer as new lines appear. 288Turn on/off scrolling with the scrollback buffer as new lines appear.
259This only takes effect if B<-si> is also given; resource 289This only takes effect if B<-si> is also given; resource
260B<scrollWithBuffer>. 290B<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 291
271=item B<-ptab>|B<+ptab> 292=item B<-ptab>|B<+ptab>
272 293
273If enabled (default), "Horizontal Tab" characters are being stored as 294If enabled (default), "Horizontal Tab" characters are being stored as
274actual wide characters in the screen buffer, which makes it possible to 295actual wide characters in the screen buffer, which makes it possible to
278 299
279=item B<-bc>|B<+bc> 300=item B<-bc>|B<+bc>
280 301
281Blink the cursor; resource B<cursorBlink>. 302Blink the cursor; resource B<cursorBlink>.
282 303
304=item B<-uc>|B<+uc>
305
306Make the cursor underlined; resource B<cursorUnderline>.
307
283=item B<-iconic> 308=item B<-iconic>
284 309
285Start iconified, if the window manager supports that option. 310Start iconified, if the window manager supports that option.
286Alternative form is B<-ic>. 311Alternative form is B<-ic>.
287 312
303 328
304=item B<-bl> 329=item B<-bl>
305 330
306Compile I<frills>: Set MWM hints to request a borderless window, i.e. 331Compile 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 332if honoured by the WM, the rxvt-unicode window will not have window
308decorations; resource B<borderLess>. 333decorations; resource B<borderLess>. If the window manager does not
334support MWM hints (e.g. kwin), enables override-redirect mode.
309 335
310=item B<-override-redirect> 336=item B<-override-redirect>
311 337
312Compile I<frills>: Sets override-redirect on the window; resource 338Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>. 339B<override-redirect>.
321 347
322=item B<-lsp> I<number> 348=item B<-lsp> I<number>
323 349
324Compile I<frills>: Lines (pixel height) to insert between each row of 350Compile I<frills>: Lines (pixel height) to insert between each row of
325the display. Useful to work around font rendering problems; resource 351the display. Useful to work around font rendering problems; resource
326B<linespace>. 352B<lineSpace>.
353
354=item B<-letsp> I<number>
355
356Compile I<frills>: Amount to adjust the computed character width by
357to control overall letter spacing. Negative values will tighten up the
358letter spacing, positive values will space letters out more. Useful to
359work around odd font metrics; resource B<letterSpace>.
327 360
328=item B<-tn> I<termname> 361=item B<-tn> I<termname>
329 362
330This option specifies the name of the terminal type to be set in the 363This option specifies the name of the terminal type to be set in the
331B<TERM> environment variable. This terminal type must exist in the 364B<TERM> environment variable. This terminal type must exist in the
385for more info. 418for more info.
386 419
387=item B<-tcw> 420=item B<-tcw>
388 421
389Change the meaning of triple-click selection with the left mouse 422Change the meaning of triple-click selection with the left mouse
423button. Only effective when the original (non-perl) selection code is
390button. Instead of selecting a full line it will extend the selection the 424in-use. Instead of selecting a full line it will extend the selection to
391end of the logical line only. resource B<tripleclickwords>. 425the end of the logical line only. resource B<tripleclickwords>.
392 426
393=item B<-insecure> 427=item B<-insecure>
394 428
395Enable "insecure" mode, which currently enables most of the escape 429Enable "insecure" mode, which currently enables most of the escape
396sequences that echo strings. See the resource B<insecure> for more 430sequences that echo strings. See the resource B<insecure> for more
417Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 451Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418will not immediately destroy its window when the program executed within 452will 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 453it exits. Instead, it will wait till it is being killed or closed by the
420user; resource B<hold>. 454user; resource B<hold>.
421 455
456=item B<-cd> I<path>
457
458Sets the working directory for the shell (or the command specified via
459B<-e>). The I<path> must be an absolute path and it must exist for
460@@RXVT_NAME@@ to start; resource B<chdir>.
461
462=item B<-xrm> I<string>
463
464Works like the X Toolkit option of the same name, by adding the I<string>
465as if it were specified in a resource file. Resource values specified this
466way take precedence over all other resource specifications.
467
468Note that you need to use the I<same> syntax as in the .Xdefaults file,
469e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
470options can be specified as long-options on the commandline, so use
471of B<-xrm> is mostly limited to cases where you want to specify other
472resources (e.g. for input methods) or for compatibility with other
473programs.
474
422=item B<-keysym.>I<sym> I<string> 475=item B<-keysym.>I<sym> I<string>
423 476
424Remap a key symbol. See resource B<keysym>. 477Remap a key symbol. See resource B<keysym>.
425 478
426=item B<-embed> I<windowid> 479=item B<-embed> I<windowid>
436The window will not be destroyed when @@RXVT_NAME@@ exits. 489The window will not be destroyed when @@RXVT_NAME@@ exits.
437 490
438It might be useful to know that @@RXVT_NAME@@ will not close file 491It 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 492descriptors passed to it (except for stdin/out/err, of course), so you
440can use file descriptors to communicate with the programs within the 493can use file descriptors to communicate with the programs within the
441terminal. This works regardless of wether the C<-embed> option was used or 494terminal. This works regardless of whether the C<-embed> option was used or
442not. 495not.
443 496
444Here is a short Gtk2-perl snippet that illustrates how this option can be 497Here is a short Gtk2-perl snippet that illustrates how this option can be
445used (a longer example is in F<doc/embed>): 498used (a longer example is in F<doc/embed>):
446 499
451 }); 504 });
452 505
453=item B<-pty-fd> I<file descriptor> 506=item B<-pty-fd> I<file descriptor>
454 507
455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 508Tells @@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 509pair 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 510useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458without having to run a program within it. 511without having to run a program within it.
459 512
460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 513If 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 514entries and will not tinker with pty/tty permissions - you have to do that
462yourself if you want that. 515yourself if you want that.
463 516
464As an extremely special case, specifying C<-1> will completely suppress 517As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations. 518pty/tty operations, which is probably only useful in conjunction with some
519perl extension that manages the terminal.
466 520
467Here is a example in perl that illustrates how this option can be used (a 521Here is a example in perl that illustrates how this option can be used (a
468longer example is in F<doc/pty-fd>): 522longer example is in F<doc/pty-fd>):
469 523
470 use IO::Pty; 524 use IO::Pty;
484Comma-separated list of perl extension scripts to use (or not to use) in 538Comma-separated list of perl extension scripts to use (or not to use) in
485this terminal instance. See resource B<perl-ext> for details. 539this terminal instance. See resource B<perl-ext> for details.
486 540
487=back 541=back
488 542
489=head1 RESOURCES (available also as long-options) 543=head1 RESOURCES
490 544
491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 545Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492options) compiled into your version. 546options) compiled into your version. All resources are also available as
547long-options.
493 548
494You can set and change the resources using X11 tools like B<xrdb>. Many 549You 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 550distribution do also load settings from the B<~/.Xresources> file when X
496starts. @@RXVT_NAME@@ will consult the following files/resources in order, 551starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497with later settings overwriting earlier ones: 552with later settings overwriting earlier ones:
498 553
499 1. system-wide app-defaults file, either locale-dependent OR global
500 2. app-defaults file in $XAPPLRESDIR 554 1. app-defaults file in $XAPPLRESDIR
555 2. $HOME/.Xdefaults
501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 556 3. RESOURCE_MANAGER property on root-window of screen 0
502 4. SCREEN_RESOURCES for the current screen 557 4. SCREEN_RESOURCES property on root-window of the current screen
503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 558 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
559 6. resources specified via -xrm on the commandline
504 560
505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 561Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
506names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 562names: 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 563common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
508configured, while the class name B<URxvt> allows resources unique to 564configured, while the class name B<URxvt> allows resources unique to
518=item B<depth:> I<bitdepth> 574=item B<depth:> I<bitdepth>
519 575
520Compile I<xft>: Attempt to find a visual with the given bit depth; 576Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>. 577option B<-depth>.
522 578
579=item B<buffered:> I<boolean>
580
581Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
582On some card/driver combination enabling it slightly decreases
583performance, on most it greatly helps it. The slowdown is small, so it
584should normally be enabled.
585
523=item B<geometry:> I<geom> 586=item B<geometry:> I<geom>
524 587
525Create the window with the specified X window geometry [default 80x24]; 588Create the window with the specified X window geometry [default 80x24];
526option B<-geometry>. 589option B<-geometry>.
527 590
540Use the specified colour for the colour value I<n>, where 0-7 603Use the specified colour for the colour value I<n>, where 0-7
541corresponds to low-intensity (normal) colours and 8-15 corresponds to 604corresponds to low-intensity (normal) colours and 8-15 corresponds to
542high-intensity (bold = bright foreground, blink = bright background) 605high-intensity (bold = bright foreground, blink = bright background)
543colours. The canonical names are as follows: 0=black, 1=red, 2=green, 606colours. 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 6073=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
545names used are listed in the B<COLORS AND GRAPHICS> section. 608names used are listed in the B<COLOURS AND GRAPHICS> section.
546 609
547Colours higher than 15 cannot be set using resources (yet), but can be 610Colours higher than 15 cannot be set using resources (yet), but can be
548changed using an escape command (see @@RXVT_NAME@@(7)). 611changed using an escape command (see @@RXVT_NAME@@(7)).
549 612
550Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 613Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
561=item B<colorUL:> I<colour> 624=item B<colorUL:> I<colour>
562 625
563Use the specified colour to display underlined characters when the 626Use the specified colour to display underlined characters when the
564foreground colour is the default. 627foreground colour is the default.
565 628
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> 629=item B<underlineColor:> I<colour>
572 630
573If set, use the specified colour as the colour for the underline 631If set, use the specified colour as the colour for the underline
574itself. If unset, use the foreground colour. 632itself. If unset, use the foreground colour.
633
634=item B<highlightColor:> I<colour>
635
636If set, use the specified colour as the background for highlighted
637characters. If unset, use reverse video.
638
639=item B<highlightTextColor:> I<colour>
640
641If set and highlightColor is set, use the specified colour as the
642foreground for highlighted characters.
575 643
576=item B<cursorColor:> I<colour> 644=item B<cursorColor:> I<colour>
577 645
578Use the specified colour for the cursor. The default is to use the 646Use the specified colour for the cursor. The default is to use the
579foreground colour; option B<-cr>. 647foreground colour; option B<-cr>.
586 654
587=item B<reverseVideo:> I<boolean> 655=item B<reverseVideo:> I<boolean>
588 656
589B<True>: simulate reverse video by foreground and background colours; 657B<True>: simulate reverse video by foreground and background colours;
590option B<-rv>. B<False>: regular screen colours [default]; option 658option B<-rv>. B<False>: regular screen colours [default]; option
591B<+rv>. See note in B<COLORS AND GRAPHICS> section. 659B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
592 660
593=item B<jumpScroll:> I<boolean> 661=item B<jumpScroll:> I<boolean>
594 662
595B<True>: specify that jump scrolling should be used. When scrolling 663B<True>: specify that jump scrolling should be used. When receiving lots
596quickly, fewer screen updates are performed [default]; option B<-j>. 664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
665has been read, resulting in fewer updates while still displaying every
666received line; option B<-j>.
667
597B<False>: specify that smooth scrolling should be used; option B<+j>. 668B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
669force a screen refresh on each new line it received; option B<+j>.
598 670
599=item B<inheritPixmap:> I<boolean> 671=item B<skipScroll:> I<boolean>
600 672
601B<True>: make the background inherit the parent windows' pixmap, giving 673B<True>: (the default) specify that skip scrolling should be used. When
602artificial transparency. B<False>: do not inherit the parent windows' 674receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603pixmap. 675(around 60 times per second), resulting in far fewer updates. This can
676result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
677option B<-ss>.
604 678
605I<Please note that transparency of any kind if completely unsupported by 679B<False>: specify that everything is to be displayed, even
606the author. Don't bug him with installation questions!> 680if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>.
682
683=item B<transparent:> I<boolean>
684
685Turn on/off pseudo-transparency by using the root pixmap as background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
607 689
608=item B<fading:> I<number> 690=item B<fading:> I<number>
609 691
610Fade the text by the given percentage when focus is lost; option B<-fade>. 692Fade the text by the given percentage when focus is lost; option B<-fade>.
611 693
614Fade to this colour, when fading is used (see B<fading:>). The default 696Fade to this colour, when fading is used (see B<fading:>). The default
615colour is black; option B<-fadecolor>. 697colour is black; option B<-fadecolor>.
616 698
617=item B<tintColor:> I<colour> 699=item B<tintColor:> I<colour>
618 700
619Tint the transparent background pixmap with the given colour; option 701Tint the transparent background with the given colour. If the RENDER
620B<-tint>. 702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
621 706
622=item B<shading:> I<number> 707=item B<shading:> I<number>
623 708
624Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
625image in addition to tinting it. 710A value of 100 means no shading; option B<-sh>.
711
712=item B<blurRadius:> I<number>
713
714Apply gaussian blur with the specified radius to the transparent
715background; option B<-blr>.
716
717=item B<iconFile:> I<file>
718
719Set the application icon pixmap; option B<-icon>.
626 720
627=item B<scrollColor:> I<colour> 721=item B<scrollColor:> I<colour>
628 722
629Use the specified colour for the scrollbar [default #B2B2B2]. 723Use the specified colour for the scrollbar [default #B2B2B2].
630 724
636=item B<borderColor:> I<colour> 730=item B<borderColor:> I<colour>
637 731
638The colour of the border around the text area and between the scrollbar 732The colour of the border around the text area and between the scrollbar
639and the text. 733and the text.
640 734
641=item B<backgroundPixmap:> I<file[;geom]> 735=item B<backgroundPixmap:> I<file[;oplist]>
642 736
643Use the specified XPM file (note the `.xpm' extension is optional) for 737Use the specified image file for the background and also
644the background and also optionally specify its scaling with a geometry 738optionally specify a colon separated list of operations to modify it.
645string B<WxH+X+Y>, in which B<"W" / "H"> specify the 739Supported operations are:
646horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 740
647centre (percent). A scale of 0 displays the image with tiling. A scale 741=over 4
648of 1 displays the image without any scaling. A scale of 2 to 9 742
649specifies an integer number of images in that direction. No image will 743=item B<WxH+X+Y>
650be magnified beyond 10 times its original size. The maximum permitted 744
651scale is 1000. [default 0x0+50+50] 745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
746scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
747scale of 0 disables scaling.
748
749=item B<op=tile>
750
751enables tiling
752
753=item B<op=keep-aspect>
754
755maintain the image aspect ratio when scaling
756
757=item B<op=root-align>
758
759use the position of the terminal window relative to the root window as
760the image offset, simulating a root window background
761
762=back
763
764The default scale and position setting is C<100x100+50+50>.
765Alternatively, a predefined set of templates can be used to achieve
766the most common setups:
767
768=over 4
769
770=item B<style=tiled>
771
772the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
773
774=item B<style=aspect-stretched>
775
776the image is scaled to fill the whole window maintaining the aspect
777ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
778
779=item B<style=stretched>
780
781the image is scaled to fill the whole window. Equivalent to 100x100
782
783=item B<style=centered>
784
785the image is centered with no scaling. Equivalent to 0x0+50+50
786
787=item B<style=root-tiled>
788
789the image is tiled with no scaling and using 'root' positioning.
790Equivalent to 0x0:op=tile:op=root-align
791
792=back
793
794If multiple templates are specified the last one wins. Note that a
795template overrides all the scale, position and operations settings.
796
797If used in conjunction with B<-tr> option, the specified pixmap will be
798blended over the transparent background using alpha-blending.
652 799
653=item B<path:> I<path> 800=item B<path:> I<path>
654 801
655Specify the colon-delimited search path for finding XPM files. 802Specify the colon-delimited search path for finding background image files.
656 803
657=item B<font:> I<fontlist> 804=item B<font:> I<fontlist>
658 805
659Select the fonts to be used. This is a comma separated list of font names 806Select 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 807that 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 830it is named first) and thus defines the character cell grid to be 9 pixels
684wide and 15 pixels high. 831wide and 15 pixels high.
685 832
686The second font is just used to add additional unicode characters not in 833The second font is just used to add additional unicode characters not in
687the base font, likewise the third, which is unfortunately non-bold, but 834the 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 835the bold version of the font does contain fewer characters, so this is a
689useful supplement. 836useful supplement.
690 837
691The third font is an Xft font with aliasing turned off, and the characters 838The 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 839are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
693contains other characters, but we are not interested in them. 840contains other characters, but we are not interested in them.
717text font will being used for the given style. 864text font will being used for the given style.
718 865
719=item B<intensityStyles:> I<boolean> 866=item B<intensityStyles:> I<boolean>
720 867
721When font styles are not enabled, or this option is enabled (B<True>, 868When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high 869option B<-is>, the default), bold/blink font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>, 870intensity foreground/background colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not 871option B<+is>) disables this behaviour, the high intensity colours are not
725reachable. 872reachable.
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 873
738=item B<title:> I<string> 874=item B<title:> I<string>
739 875
740Set window title string, the default title is the command-line 876Set window title string, the default title is the command-line
741specified after the B<-e> option, if any, otherwise the application 877specified after the B<-e> option, if any, otherwise the application
750=item B<mapAlert:> I<boolean> 886=item B<mapAlert:> I<boolean>
751 887
752B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 888B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753de-iconify (map) on receipt of a bell character [default]. 889de-iconify (map) on receipt of a bell character [default].
754 890
891=item B<urgentOnBell:> I<boolean>
892
893B<True>: set the urgency hint for the wm on receipt of a bell character.
894B<False>: do not set the urgency hint [default].
895
896@@RXVT_NAME@@ resets the urgency hint on every focus change.
897
755=item B<visualBell:> I<boolean> 898=item B<visualBell:> I<boolean>
756 899
757B<True>: use visual bell on receipt of a bell character; option B<-vb>. 900B<True>: use visual bell on receipt of a bell character; option B<-vb>.
758B<False>: no visual bell [default]; option B<+vb>. 901B<False>: no visual bell [default]; option B<+vb>.
759 902
780Example: 923Example:
781 924
782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 925 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783 926
784This creates a new file in your home directory with the screen contents 927This creates a new file in your home directory with the screen contents
785everytime you hit C<Print>. 928every time you hit C<Print>.
929
930=item B<scrollstyle:> I<mode>
931
932Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
933the author's favourite.
934
935=item B<thickness:> I<number>
936
937Set the scrollbar width in pixels.
786 938
787=item B<scrollBar:> I<boolean> 939=item B<scrollBar:> I<boolean>
788 940
789B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 941B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790disable the scrollbar; option B<+sb>. 942disable the scrollbar; option B<+sb>.
810B<False>: do not scroll to bottom when tty receives output; option 962B<False>: do not scroll to bottom when tty receives output; option
811B<+si>. 963B<+si>.
812 964
813=item B<scrollWithBuffer:> I<boolean> 965=item B<scrollWithBuffer:> I<boolean>
814 966
815B<True>: scroll with scrollback buffer when tty receives new lines (and 967B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
816B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 968try to show the same lines) and B<scrollTtyOutput> is False; option
817with scrollback buffer when tty recieves new lines; option B<+sw>. 969B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
970new lines; option B<+sw>.
818 971
819=item B<scrollTtyKeypress:> I<boolean> 972=item B<scrollTtyKeypress:> I<boolean>
820 973
821B<True>: scroll to bottom when a non-special key is pressed. Special keys 974B<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 975are those which are intercepted by rxvt-unicode for special handling and
853=item B<termName:> I<termname> 1006=item B<termName:> I<termname>
854 1007
855Specifies the terminal type name to be set in the B<TERM> environment 1008Specifies the terminal type name to be set in the B<TERM> environment
856variable; option B<-tn>. 1009variable; option B<-tn>.
857 1010
858=item B<linespace:> I<number> 1011=item B<lineSpace:> I<number>
859 1012
860Specifies number of lines (pixel height) to insert between each row of 1013Specifies number of lines (pixel height) to insert between each row of
861the display [default 0]; option B<-lsp>. 1014the display [default 0]; option B<-lsp>.
862 1015
863=item B<meta8:> I<boolean> 1016=item B<meta8:> I<boolean>
877 1030
878=item B<cursorBlink:> I<boolean> 1031=item B<cursorBlink:> I<boolean>
879 1032
880B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1033B<True>: blink the cursor. B<False>: do not blink the cursor [default];
881option B<-bc>. 1034option B<-bc>.
1035
1036=item B<cursorUnderline:> I<boolean>
1037
1038B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1039option B<-uc>.
882 1040
883=item B<pointerBlank:> I<boolean> 1041=item B<pointerBlank:> I<boolean>
884 1042
885B<True>: blank the pointer when a key is pressed or after a set number 1043B<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 1044of seconds of inactivity. B<False>: the pointer is always visible
900large number (e.g. C<987654321>) to effectively disable the timeout. 1058large number (e.g. C<987654321>) to effectively disable the timeout.
901 1059
902=item B<backspacekey:> I<string> 1060=item B<backspacekey:> I<string>
903 1061
904The string to send when the backspace key is pressed. If set to B<DEC> 1062The 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> 1063or 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 1064(code 8) - which can be reversed with the appropriate DEC private mode
907escape sequence. 1065escape sequence.
908 1066
909=item B<deletekey:> I<string> 1067=item B<deletekey:> I<string>
910 1068
915=item B<cutchars:> I<string> 1073=item B<cutchars:> I<string>
916 1074
917The characters used as delimiters for double-click word selection 1075The characters used as delimiters for double-click word selection
918(whitespace delimiting is added automatically if resource is given). 1076(whitespace delimiting is added automatically if resource is given).
919 1077
920When the selection extension is in use (the default if compiled in, see 1078When the perl selection extension is in use (the default if compiled
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1079in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922will be created (if the resource exists, otherwise, no regex will be 1080characters will be created (if the resource exists, otherwise, no regex
923created). In this mode, characters outside ISO-8859-1 can be used. 1081will be created). In this mode, characters outside ISO-8859-1 can be used.
924 1082
925When the selection extension is not used, only ISO-8859-1 characters can 1083When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used: 1084be used. If not specified, the built-in default is used:
927 1085
928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1086B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
929 1087
930=item B<preeditType:> I<style> 1088=item B<preeditType:> I<style>
931 1089
932B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1090B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933 1091
987 1145
988Turn on/off secondary screen (default enabled). 1146Turn on/off secondary screen (default enabled).
989 1147
990=item B<secondaryScroll:> I<boolean> 1148=item B<secondaryScroll:> I<boolean>
991 1149
992Turn on/off secondary screen scroll (default enabled). If the this 1150Turn on/off secondary screen scroll (default enabled). If this
993option is enabled, scrolls on the secondary screen will change the 1151option is enabled, scrolls on the secondary screen will change the
994scrollback buffer and switching to/from the secondary screen will 1152scrollback buffer and, when secondaryScreen is off, switching
995instead scroll the screen up. 1153to/from the secondary screen will instead scroll the screen up.
996 1154
997=item B<hold>: I<boolean> 1155=item B<hold>: I<boolean>
998 1156
999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1157Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000will not immediately destroy its window when the program executed within 1158will 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 1159it exits. Instead, it will wait till it is being killed or closed by the
1002user. 1160user.
1161
1162=item B<chdir>: I<path>
1163
1164Sets the working directory for the shell (or the command specified via
1165B<-e>). The I<path> must be an absolute path and it must exist for
1166@@RXVT_NAME@@ to start. If it isn't specified then the current working
1167directory will be used; option B<-cd>.
1003 1168
1004=item B<keysym.>I<sym>: I<string> 1169=item B<keysym.>I<sym>: I<string>
1005 1170
1006Compile I<frills>: Associate I<string> with keysym I<sym>. The 1171Compile I<frills>: Associate I<string> with keysym I<sym>. The
1007intervening resource name B<keysym.> cannot be omitted. 1172intervening resource name B<keysym.> cannot be omitted.
1021searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1186searching 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 1187omitting 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 1188keysym 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. 1189performed in an exact manner; however, the closest match is assured.
1025 1190
1026I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1191I<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, 1192number), 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 1193
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> 1194You can define a range of keysyms in one shot by
1195loading the C<keysym-list> perl extension and providing a I<string>
1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1196with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039should be a character not used by the strings. 1197should be a character not used by the strings.
1040 1198
1041Its usage can be demonstrated by an example: 1199Its usage can be demonstrated by an example:
1042 1200
1043 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1201 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1044 1202
1045The above line is equivalent to the following three lines: 1203The above line is equivalent to the following three lines:
1046 1204
1047 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1205 URxvt.keysym.Meta-Control-0x61: \033<a>
1048 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1206 URxvt.keysym.Meta-Control-0x62: \033<b>
1049 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1207 URxvt.keysym.Meta-Control-0x63: \033<c>
1050 1208
1051If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1209If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1052is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1210is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1053example the following means "change the current locale to C<zh_CN.GBK> 1211example the following means "change the current locale to C<zh_CN.GBK>
1054when Control-Meta-c is being pressed": 1212when Control-Meta-c is being pressed":
1055 1213
1056 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1214 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057 1215
1058If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1216If 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) 1217is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060manpage. For example, the F<selection> extension (activated via 1218manpage. For example, the F<selection> extension (activated via
1061C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1219C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062 1220
1063 URxvt.keysym.M-C-c: perl:selection:rot13 1221 URxvt.keysym.M-C-c: perl:selection:rot13
1064 1222
1065Due the the large number of modifier combinations, a defined key mapping 1223Due 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 1224will 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 1225no other key mappings with those and more bits are being defined. That
1068means that defining a key map for C<a> will automatically provide 1226means 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 1227definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1070mappings themselves. 1228mappings themselves.
1071 1229
1107example, C<default,-selection> will use all the default extension except 1265example, C<default,-selection> will use all the default extension except
1108C<selection>. 1266C<selection>.
1109 1267
1110Extension names can also be followed by an argument in angle brackets 1268Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1269(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension 1270searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to 1271multiple times with different arguments will pass multiple arguments to
1114the extension. 1272the extension.
1115 1273
1116Each extension is looked up in the library directories, loaded if 1274Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance. 1275necessary, and bound to the current terminal instance.
1122all instances, while B<perl-ext> is used for specific instances. 1280all instances, while B<perl-ext> is used for specific instances.
1123 1281
1124=item B<perl-eval>: I<string> 1282=item B<perl-eval>: I<string>
1125 1283
1126Perl code to be evaluated when all extensions have been registered. See 1284Perl code to be evaluated when all extensions have been registered. See
1127the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1285the @@RXVT_NAME@@perl(3) manpage.
1128will be ignored when running setuid/setgid.
1129 1286
1130=item B<perl-lib>: I<path> 1287=item B<perl-lib>: I<path>
1131 1288
1132Colon-separated list of additional directories that hold extension 1289Colon-separated list of additional directories that hold extension
1133scripts. When looking for extensions specified by the C<perl> resource, 1290scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1134@@RXVT_NAME@@ will first look in these directories and then in 1291look in these directories, then in $HOME/.urxvt/ext and lastly in
1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1292F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1136will be ignored when running setuid/setgid.
1137 1293
1138See the @@RXVT_NAME@@perl(3) manpage. 1294See the @@RXVT_NAME@@perl(3) manpage.
1139 1295
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1296=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141 1297
1153(default: C<M-s>). 1309(default: C<M-s>).
1154 1310
1155=item B<urlLauncher>: I<string> 1311=item B<urlLauncher>: I<string>
1156 1312
1157Specifies the program to be started with a URL argument. Used by the 1313Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions. 1314C<selection-popup> and C<matcher> perl extensions.
1159 1315
1160=item B<transient-for>: I<windowid> 1316=item B<transient-for>: I<windowid>
1161 1317
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1318Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163 1319
1164=item B<override-redirect>: I<boolean> 1320=item B<override-redirect>: I<boolean>
1165 1321
1166Compile I<frills>: Sets override-redirect for the terminal window, making 1322Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>. 1323it almost invisible to window managers; option B<-override-redirect>.
1324
1325=item B<iso14755:> I<boolean>
1326
1327Turn on/off ISO 14755 (default enabled).
1328
1329=item B<iso14755_52:> I<boolean>
1330
1331Turn on/off ISO 14755 5.2 mode (default enabled).
1168 1332
1169=back 1333=back
1170 1334
1171=head1 THE SCROLLBAR 1335=head1 THE SCROLLBAR
1172 1336
1191application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1355application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1356(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), 1357up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194respectively. 1358respectively.
1195 1359
1196=head1 TEXT SELECTION AND INSERTION 1360=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197 1361
1198The behaviour of text selection and insertion mechanism is similar to 1362The behaviour of text selection and insertion/pasting mechanism is similar
1199I<xterm>(1). 1363to I<xterm>(1).
1200 1364
1201=over 4 1365=over 4
1202 1366
1203=item B<Selection>: 1367=item B<Selecting>:
1204 1368
1205Left click at the beginning of the region, drag to the end of the region 1369Left 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 1370and release; Right click to extend the marked region; Left double-click
1207to select a word; Left triple-click to select the entire logical line 1371to select a word; Left triple-click to select the entire logical line
1208(which can span multiple screen lines), unless modified by resource 1372(which can span multiple screen lines), unless modified by resource
1212(Compile: I<frills>) will create a rectangular selection instead of a 1376(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 1377normal one. In this mode, every selected row becomes its own line in the
1214selection, and trailing whitespace is visually underlined and removed from 1378selection, and trailing whitespace is visually underlined and removed from
1215the selection. 1379the selection.
1216 1380
1217=item B<Insertion>: 1381=item B<Pasting>:
1218 1382
1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1383Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220window causes the value of the PRIMARY selection (or CLIPBOARD with the 1384window 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. 1385B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222 1386
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1387Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too. 1388inserted too.
1225 1389
1226=back 1390=back
1243 1407
1244=head1 ISO 14755 SUPPORT 1408=head1 ISO 14755 SUPPORT
1245 1409
1246ISO 14755 is a standard for entering and viewing unicode characters 1410ISO 14755 is a standard for entering and viewing unicode characters
1247and character codes using the keyboard. It consists of 4 parts. The 1411and character codes using the keyboard. It consists of 4 parts. The
1248first part is available rxvt-unicode has been compiled with 1412first part is available if rxvt-unicode has been compiled with
1249C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1413C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250with C<--enable-iso14755>. 1414with C<--enable-iso14755>.
1251 1415
1252=over 4 1416=over 4
1253 1417
1311B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1475B<@@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 1476it 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 1477allow 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. 1478on some systems or setgid to root or to some other group on others.
1315 1479
1316=head1 COLORS AND GRAPHICS 1480=head1 COLOURS AND GRAPHICS
1317 1481
1318In addition to the default foreground and background colours, 1482In addition to the default foreground and background colours,
1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1483B<@@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 1484high-intensity (potentially bold/blink) versions of the same, and 72 (or
1321colours with their names. 1485240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1486cube plus a 8 (24) colour greyscale ramp.
1487
1488Here is a list of the ANSI colours with their names.
1322 1489
1323=begin table 1490=begin table
1324 1491
1325 B<color0> (black) = Black 1492 B<color0> (black) = Black
1326 B<color1> (red) = Red3 1493 B<color1> (red) = Red3
1346It is also possible to specify the colour values of B<foreground>, 1513It is also possible to specify the colour values of B<foreground>,
1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1514B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1348a number 0-15, as a convenient shorthand to reference the colour name of 1515a number 0-15, as a convenient shorthand to reference the colour name of
1349color0-color15. 1516color0-color15.
1350 1517
1351In addition to the colours defined above, @@RXVT_NAME@@ offers an 1518The following text gives values for the standard 88 colour mode (and
1352additional 72 colours. The first 64 of those (with indices 16 to 79) 1519values 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 1520
1521The RGB cube uses indices 16..79 (16..231) using the following formulas:
1522
1523 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1524 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1525
1526The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1527steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1528the RGB cube.
1529
1356Together, all those colours implement the 88 colour xterm colours. Only 1530Together, all those colours implement the 88 (256) colour xterm
1357the first 16 can be changed using resources currently, the rest can only 1531colours. Only the first 16 can be changed using resources currently, the
1358be changed via command sequences ("escape codes"). 1532rest can only be changed via command sequences ("escape codes").
1533
1534Applications are advised to use terminfo or command sequences to discover
1535number and RGB values of all colours (yes, you can query this...).
1359 1536
1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1537Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1361always swapping the foreground/background colours. This is in contrast to 1538always swapping the foreground/background colours. This is in contrast to
1362I<xterm>(1) where the colours are only swapped if they have not otherwise 1539I<xterm>(1) where the colours are only swapped if they have not otherwise
1363been specified. For example, 1540been specified. For example,
1364 1541
1542 @@RXVT_NAME@@ -fg Black -bg White -rv
1543
1544would yield White on Black, while on I<xterm>(1) it would yield Black on
1545White.
1546
1547=head2 ALPHA CHANNEL SUPPORT
1548
1549If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1550their act together, rxvt-unicode will do its own alpha channel management:
1551
1552You can prefix any colour with an opaqueness percentage enclosed in
1553brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1554(0-100) that specifies the opacity of the colour, where C<0> is completely
1555transparent and C<100> is completely opaque. For example, C<[50]red> is a
1556half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1557is the recommended format to specify transparency values, and works with
1558all ways to specify a colour.
1559
1560For complete control, rxvt-unicode also supports
1561C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1562specifications, where the additional C<aaaa> component specifies opacity
1563(alpha) values. The minimum value of C<0000> is completely transparent,
1564while C<ffff> is completely opaque). The two example colours from
1565earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1566C<rgba:0000/ff00/0000/f332>.
1567
1568You probably need to specify B<"-depth 32">, too, to force a visual with
1569alpha channels, and have the luck that your X-server uses ARGB pixel
1570layout, as X is far from just supporting ARGB visuals out of the box, and
1571rxvt-unicode just fudges around.
1572
1573For example, the following selects an almost completely transparent black
1574background, and an almost opaque pink foreground:
1575
1576 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1577
1578When not using a background image, then the interpretation of the
1579alpha channel is up to your compositing manager (most interpret it as
1580transparency of course).
1581
1582When using a background pixmap or pseudo-transparency, then the background
1583colour will always behave as if it were completely transparent (so the
1584background image shows instead), regardless of how it was specified, while
1585other colours will either be transparent as specified (the background
1586image will show through) on servers supporting the RENDER extension, or
1587fully opaque on servers not supporting the RENDER EXTENSION.
1588
1589Please note that due to bugs in Xft, specifying alpha values might result
1590in garbage being displayed when the X-server does not support the RENDER
1591extension.
1592
1593=head1 ENVIRONMENT
1594
1595B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1596
1365=over 4 1597=over 4
1366 1598
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> 1599=item B<TERM>
1403 1600
1404Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1601Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405resources or on the commandline. 1602resources or on the command line.
1406 1603
1407=item B<COLORTERM> 1604=item B<COLORTERM>
1408 1605
1409Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1606Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410compiled with XPM support, and optionally with the added extension 1607compiled with background image support, and optionally with the added
1411C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1608extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1609screen.
1412 1610
1413=item B<COLORFGBG> 1611=item B<COLORFGBG>
1414 1612
1415Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1613Set 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 1614the colour code used as default foreground/text colour (or the string
1417C<default> to indicate that the default-colour escape sequence is to be 1615C<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 1616used), 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@@ 1617string 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 1618was compiled with background image support. Libraries like C<ncurses>
1421(and do) use this information to optimize screen output. 1619and C<slang> can (and do) use this information to optimize screen output.
1422 1620
1423=item B<WINDOWID> 1621=item B<WINDOWID>
1424 1622
1425Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1623Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426window, which usually has subwindows for the scrollbar, the terminal 1624window, which usually has subwindows for the scrollbar, the terminal
1432C<--with-terminfo=PATH>. 1630C<--with-terminfo=PATH>.
1433 1631
1434=item B<DISPLAY> 1632=item B<DISPLAY>
1435 1633
1436Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1634Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437display in its child processes. 1635display in its child processes if C<-display> isn't used to override. It
1636defaults to C<:0> if it doesn't exist.
1438 1637
1439=item B<SHELL> 1638=item B<SHELL>
1440 1639
1441The shell to be used for command execution, defaults to C</bin/sh>. 1640The shell to be used for command execution, defaults to C</bin/sh>.
1442 1641
1443=item B<RXVT_SOCKET> 1642=item B<RXVT_SOCKET>
1444 1643
1445The unix domain socket path used by @@RXVT_NAME@@c(1) and 1644The unix domain socket path used by @@RXVT_NAME@@c(1) and
1446@@RXVT_NAME@@d(1). 1645@@RXVT_NAME@@d(1).
1447 1646
1448Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1647Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1449 1648
1450=item B<HOME> 1649=item B<HOME>
1451 1650
1452Used to locate the default directory for the unix domain socket for 1651Used to locate the default directory for the unix domain socket for
1453daemon communications and to locate various resource files (such as 1652daemon communications and to locate various resource files (such as
1454C<.Xdefaults>) 1653C<.Xdefaults>)
1455 1654
1456=item B<XAPPLRESDIR> 1655=item B<XAPPLRESDIR>
1457 1656
1458Directory where various X resource files are being located. 1657Directory where application-specific X resource files are located.
1459 1658
1460=item B<XENVIRONMENT> 1659=item B<XENVIRONMENT>
1461 1660
1462If set and accessible, gives the name of a X resource file to be loaded by 1661If set and accessible, gives the name of a X resource file to be loaded by
1463@@RXVT_NAME@@. 1662@@RXVT_NAME@@.
1468 1667
1469=over 4 1668=over 4
1470 1669
1471=item B</usr/lib/X11/rgb.txt> 1670=item B</usr/lib/X11/rgb.txt>
1472 1671
1473Color names. 1672Colour names.
1474 1673
1475=back 1674=back
1476 1675
1477=head1 SEE ALSO 1676=head1 SEE ALSO
1478 1677
1517Project Coordinator (changes.txt 2.21a to 2.4.5) 1716Project Coordinator (changes.txt 2.21a to 2.4.5)
1518 1717
1519=item Geoff Wing L<< <gcw@pobox.com> >> 1718=item Geoff Wing L<< <gcw@pobox.com> >>
1520 1719
1521Rewrote screen display and text selection routines. 1720Rewrote screen display and text selection routines.
1522 1721
1523Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1722Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1524 1723
1525=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1724=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1526 1725
1527Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1726Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1529 1728
1530Project Coordinator (Changes 1.0 -) 1729Project Coordinator (Changes 1.0 -)
1531 1730
1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1731=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533 1732
1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1733pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1535 1734
1536=back 1735=back
1537 1736

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines