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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines