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

Diff Legend

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