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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines