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.100 by root, Thu Jan 19 18:02:28 2006 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 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.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
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]
97 110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
114 133
115=item B<-fade> I<number> 134=item B<-fade> I<number>
116 135
117Fade 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
118fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 138colour; resource B<fading>.
120 139
121=item B<-fadecolor> I<colour> 140=item B<-fadecolor> I<colour>
122 141
123Fade 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
124is black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
125 144
126=item B<-tint> I<colour> 145=item B<-tint> I<colour>
127 146
128Tint the transparent background pixmap with the given colour when 147Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 148transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 149non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 150used to brighten or darken the image in addition to tinting it.
151Please note that certain tint colours can be applied on the server-side,
152thus yielding performance gain of two orders of magnitude. These colours are:
153blue, red, green, cyan, magenta, yellow, and those close to them. Also
154pure black and pure white colours essentially mean no tinting; resource
132I<tintColor>. Example: 155I<tintColor>. Example:
133 156
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 157 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 158
136=item B<-sh> 159=item B<-sh> I<number>
137 160
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 161Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 162background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 163resource I<shading>.
164
165=item B<-blt> I<string>
166
167Specify background blending type. If background pixmap is specified
168at the same time as transparency - such pixmap will be blended over
169transparency image, using method specified. Supported values are :
170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
172B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
173alpha-blending. Compile I<afterimage>; resource I<blendType>.
174
175=item B<-blr> I<HxV>
176
177Apply Gaussian Blur with the specified radii to the transparent
178background image. If single number is specified - both vertical and
179horizontal radii are considered to be the same. Setting one of the
180radii to 1 and another to a large number creates interesting effects
181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
182resource I<blurRadius>.
183
184=item B<-icon> I<file>
185
186Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
187is used by many window managers, taskbars and pagers to represent the
188application window; resource I<iconFile>.
141 189
142=item B<-bg> I<colour> 190=item B<-bg> I<colour>
143 191
144Window background colour; resource B<background>. 192Window background colour; resource B<background>.
145 193
146=item B<-fg> I<colour> 194=item B<-fg> I<colour>
147 195
148Window foreground colour; resource B<foreground>. 196Window foreground colour; resource B<foreground>.
149 197
150=item B<-pixmap> I<file[;geom]> 198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 199
152Compile I<XPM>: Specify XPM file for the background and also optionally 200Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 201optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 202add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 203command-line; for more details see resource B<backgroundPixmap>.
156 204
157=item B<-cr> I<colour> 205=item B<-cr> I<colour>
158 206
159The cursor colour; resource B<cursorColor>. 207The cursor colour; resource B<cursorColor>.
160 208
177that are checked in order when trying to find glyphs for characters. The 225that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 226first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 227smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 228font list is always appended to it. See resource B<font> for more details.
181 229
182In short, to specify an X11 core font, just specify it's name or prefix it 230In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 231with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 232e.g.:
185 233
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 234 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 235 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 253italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 254for details.
207 255
208=item B<-is>|B<+is> 256=item B<-is>|B<+is>
209 257
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 258Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 259foreground/background (default). See resource B<intensityStyles> for
212details. 260details.
213 261
214=item B<-name> I<name> 262=item B<-name> I<name>
215 263
233 281
234=item B<-sb>|B<+sb> 282=item B<-sb>|B<+sb>
235 283
236Turn on/off scrollbar; resource B<scrollBar>. 284Turn on/off scrollbar; resource B<scrollBar>.
237 285
286=item B<-sr>|B<+sr>
287
288Put scrollbar on right/left; resource B<scrollBar_right>.
289
290=item B<-st>|B<+st>
291
292Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
293resource B<scrollBar_floating>.
294
238=item B<-si>|B<+si> 295=item B<-si>|B<+si>
239 296
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 297Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 298B<scrollTtyOutput> has opposite effect.
242 299
248=item B<-sw>|B<+sw> 305=item B<-sw>|B<+sw>
249 306
250Turn on/off scrolling with the scrollback buffer as new lines appear. 307Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 308This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 309B<scrollWithBuffer>.
253
254=item B<-sr>|B<+sr>
255
256Put scrollbar on right/left; resource B<scrollBar_right>.
257
258=item B<-st>|B<+st>
259
260Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
261resource B<scrollBar_floating>.
262 310
263=item B<-ptab>|B<+ptab> 311=item B<-ptab>|B<+ptab>
264 312
265If enabled (default), "Horizontal Tab" characters are being stored as 313If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 314actual wide characters in the screen buffer, which makes it possible to
270 318
271=item B<-bc>|B<+bc> 319=item B<-bc>|B<+bc>
272 320
273Blink the cursor; resource B<cursorBlink>. 321Blink the cursor; resource B<cursorBlink>.
274 322
323=item B<-uc>|B<+uc>
324
325Make the cursor underlined; resource B<cursorUnderline>.
326
275=item B<-iconic> 327=item B<-iconic>
276 328
277Start iconified, if the window manager supports that option. 329Start iconified, if the window manager supports that option.
278Alternative form is B<-ic>. 330Alternative form is B<-ic>.
279 331
295 347
296=item B<-bl> 348=item B<-bl>
297 349
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 350Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 351if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 352decorations; resource B<borderLess>. If the window manager does not
353support MWM hints (e.g. kwin), enables override-redirect mode.
301 354
302=item B<-override-redirect> 355=item B<-override-redirect>
303 356
304Compile I<frills>: Sets override-redirect on the window; resource 357Compile I<frills>: Sets override-redirect on the window; resource
305B<override-redirect>. 358B<override-redirect>.
313 366
314=item B<-lsp> I<number> 367=item B<-lsp> I<number>
315 368
316Compile I<frills>: Lines (pixel height) to insert between each row of 369Compile I<frills>: Lines (pixel height) to insert between each row of
317the display. Useful to work around font rendering problems; resource 370the display. Useful to work around font rendering problems; resource
318B<linespace>. 371B<lineSpace>.
372
373=item B<-letsp> I<number>
374
375Compile I<frills>: Amount to adjust the computed character width by
376to control overall letter spacing. Negative values will tighten up the
377letter spacing, positive values will space letters out more. Useful to
378work around odd font metrics; resource B<letterSpace>.
319 379
320=item B<-tn> I<termname> 380=item B<-tn> I<termname>
321 381
322This option specifies the name of the terminal type to be set in the 382This option specifies the name of the terminal type to be set in the
323B<TERM> environment variable. This terminal type must exist in the 383B<TERM> environment variable. This terminal type must exist in the
377for more info. 437for more info.
378 438
379=item B<-tcw> 439=item B<-tcw>
380 440
381Change the meaning of triple-click selection with the left mouse 441Change the meaning of triple-click selection with the left mouse
442button. Only effective when the original (non-perl) selection code is
382button. Instead of selecting a full line it will extend the selection the 443in-use. Instead of selecting a full line it will extend the selection to
383end of the logical line only. resource B<tripleclickwords>. 444the end of the logical line only. resource B<tripleclickwords>.
384 445
385=item B<-insecure> 446=item B<-insecure>
386 447
387Enable "insecure" mode, which currently enables most of the escape 448Enable "insecure" mode, which currently enables most of the escape
388sequences that echo strings. See the resource B<insecure> for more 449sequences that echo strings. See the resource B<insecure> for more
409Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 470Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
410will not immediately destroy its window when the program executed within 471will not immediately destroy its window when the program executed within
411it exits. Instead, it will wait till it is being killed or closed by the 472it exits. Instead, it will wait till it is being killed or closed by the
412user; resource B<hold>. 473user; resource B<hold>.
413 474
475=item B<-cd> I<path>
476
477Sets the working directory for the shell (or the command specified via
478B<-e>). The I<path> must be an absolute path and it must exist for
479@@RXVT_NAME@@ to start; resource B<chdir>.
480
481=item B<-xrm> I<string>
482
483Works like the X Toolkit option of the same name, by adding the I<string>
484as if it were specified in a resource file. Resource values specified this
485way take precedence over all other resource specifications.
486
487Note that you need to use the I<same> syntax as in the .Xdefaults file,
488e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
489options can be specified as long-options on the commandline, so use
490of B<-xrm> is mostly limited to cases where you want to specify other
491resources (e.g. for input methods) or for compatibility with other
492programs.
493
414=item B<-keysym.>I<sym> I<string> 494=item B<-keysym.>I<sym> I<string>
415 495
416Remap a key symbol. See resource B<keysym>. 496Remap a key symbol. See resource B<keysym>.
417 497
418=item B<-embed> I<windowid> 498=item B<-embed> I<windowid>
419 499
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 500Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 501which enables applications to easily embed a terminal.
422 502
423Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 503Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
424shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 504shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
425quite a bit, so don't expect it to keep some specific state. It's best to 505quite a bit, so don't expect it to keep some specific state. It's best to
428The window will not be destroyed when @@RXVT_NAME@@ exits. 508The window will not be destroyed when @@RXVT_NAME@@ exits.
429 509
430It might be useful to know that @@RXVT_NAME@@ will not close file 510It might be useful to know that @@RXVT_NAME@@ will not close file
431descriptors passed to it (except for stdin/out/err, of course), so you 511descriptors passed to it (except for stdin/out/err, of course), so you
432can use file descriptors to communicate with the programs within the 512can use file descriptors to communicate with the programs within the
433terminal. This works regardless of wether the C<-embed> option was used or 513terminal. This works regardless of whether the C<-embed> option was used or
434not. 514not.
435 515
436Here is a short Gtk2-perl snippet that illustrates how this option can be 516Here is a short Gtk2-perl snippet that illustrates how this option can be
437used (a longer example is in F<doc/embed>): 517used (a longer example is in F<doc/embed>):
438 518
443 }); 523 });
444 524
445=item B<-pty-fd> I<file descriptor> 525=item B<-pty-fd> I<file descriptor>
446 526
447Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 527Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
448pair but instead use the given filehandle as the tty master. This is 528pair but instead use the given file descriptor as the tty master. This is
449useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 529useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450without having to run a program within it. 530without having to run a program within it.
451 531
452If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 532If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
453entries and will not tinker with pty/tty permissions - you have to do that 533entries and will not tinker with pty/tty permissions - you have to do that
454yourself if you want that. 534yourself if you want that.
455 535
456As an extremely special case, specifying C<-1> will completely suppress 536As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations. 537pty/tty operations, which is probably only useful in conjunction with some
538perl extension that manages the terminal.
458 539
459Here is a example in perl that illustrates how this option can be used (a 540Here is a example in perl that illustrates how this option can be used (a
460longer example is in F<doc/pty-fd>): 541longer example is in F<doc/pty-fd>):
461 542
462 use IO::Pty; 543 use IO::Pty;
476Comma-separated list of perl extension scripts to use (or not to use) in 557Comma-separated list of perl extension scripts to use (or not to use) in
477this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
478 559
479=back 560=back
480 561
481=head1 RESOURCES (available also as long-options) 562=head1 RESOURCES
482 563
483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 564Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
484options) compiled into your version. 565options) compiled into your version. All resources are also available as
566long-options.
485 567
486You can set and change the resources using X11 tools like B<xrdb>. Many 568You can set and change the resources using X11 tools like B<xrdb>. Many
487distribution do also load settings from the B<~/.Xresources> file when X 569distribution do also load settings from the B<~/.Xresources> file when X
488starts. @@RXVT_NAME@@ will consult the following files/resources in order, 570starts. @@RXVT_NAME@@ will consult the following files/resources in order,
489with later settings overwriting earlier ones: 571with later settings overwriting earlier ones:
491 1. system-wide app-defaults file, either locale-dependent OR global 573 1. system-wide app-defaults file, either locale-dependent OR global
492 2. app-defaults file in $XAPPLRESDIR 574 2. app-defaults file in $XAPPLRESDIR
493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 575 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
494 4. SCREEN_RESOURCES for the current screen 576 4. SCREEN_RESOURCES for the current screen
495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 577 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578 6. resources specified via -xrm on the commandline
496 579
497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 580Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
498names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 581names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
499common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 582common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
500configured, while the class name B<URxvt> allows resources unique to 583configured, while the class name B<URxvt> allows resources unique to
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 589extensions not documented here):
507 590
508=over 4 591=over 4
509 592
593=item B<depth:> I<bitdepth>
594
595Compile I<xft>: Attempt to find a visual with the given bit depth;
596option B<-depth>.
597
598=item B<buffered:> I<boolean>
599
600Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
601On some card/driver combination enabling it slightly decreases
602performance, on most it greatly helps it. The slowdown is small, so it
603should normally be enabled.
604
510=item B<geometry:> I<geom> 605=item B<geometry:> I<geom>
511 606
512Create the window with the specified X window geometry [default 80x24]; 607Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 608option B<-geometry>.
514 609
527Use the specified colour for the colour value I<n>, where 0-7 622Use the specified colour for the colour value I<n>, where 0-7
528corresponds to low-intensity (normal) colours and 8-15 corresponds to 623corresponds to low-intensity (normal) colours and 8-15 corresponds to
529high-intensity (bold = bright foreground, blink = bright background) 624high-intensity (bold = bright foreground, blink = bright background)
530colours. The canonical names are as follows: 0=black, 1=red, 2=green, 625colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5313=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6263=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
532names used are listed in the B<COLORS AND GRAPHICS> section. 627names used are listed in the B<COLOURS AND GRAPHICS> section.
533 628
534Colours higher than 15 cannot be set using resources (yet), but can be 629Colours higher than 15 cannot be set using resources (yet), but can be
535changed using an escape command (see @@RXVT_NAME@@(7)). 630changed using an escape command (see @@RXVT_NAME@@(7)).
536 631
537Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 632Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
548=item B<colorUL:> I<colour> 643=item B<colorUL:> I<colour>
549 644
550Use the specified colour to display underlined characters when the 645Use the specified colour to display underlined characters when the
551foreground colour is the default. 646foreground colour is the default.
552 647
553=item B<colorRV:> I<colour>
554
555Use the specified colour as the background for reverse video
556characters.
557
558=item B<underlineColor:> I<colour> 648=item B<underlineColor:> I<colour>
559 649
560If set, use the specified colour as the colour for the underline 650If set, use the specified colour as the colour for the underline
561itself. If unset, use the foreground colour. 651itself. If unset, use the foreground colour.
652
653=item B<highlightColor:> I<colour>
654
655If set, use the specified colour as the background for highlighted
656characters. If unset, use reverse video.
657
658=item B<highlightTextColor:> I<colour>
659
660If set and highlightColor is set, use the specified colour as the
661foreground for highlighted characters.
562 662
563=item B<cursorColor:> I<colour> 663=item B<cursorColor:> I<colour>
564 664
565Use the specified colour for the cursor. The default is to use the 665Use the specified colour for the cursor. The default is to use the
566foreground colour; option B<-cr>. 666foreground colour; option B<-cr>.
573 673
574=item B<reverseVideo:> I<boolean> 674=item B<reverseVideo:> I<boolean>
575 675
576B<True>: simulate reverse video by foreground and background colours; 676B<True>: simulate reverse video by foreground and background colours;
577option B<-rv>. B<False>: regular screen colours [default]; option 677option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 678B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
579 679
580=item B<jumpScroll:> I<boolean> 680=item B<jumpScroll:> I<boolean>
581 681
582B<True>: specify that jump scrolling should be used. When scrolling 682B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 683of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
684has been read, resulting in fewer updates while still displaying every
685received line; option B<-j>.
686
584B<False>: specify that smooth scrolling should be used; option B<+j>. 687B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
688force a screen refresh on each new line it received; option B<+j>.
585 689
586=item B<inheritPixmap:> I<boolean> 690=item B<skipScroll:> I<boolean>
587 691
588B<True>: make the background inherit the parent windows' pixmap, giving 692B<True>: (the default) specify that skip scrolling should be used. When
589artificial transparency. B<False>: do not inherit the parent windows' 693receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590pixmap. 694(around 60 times per second), resulting in far fewer updates. This can
695result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
696option B<-ss>.
697
698B<False>: specify that everything is to be displayed, even
699if the refresh is too fast for the human eye to read anything (or the
700monitor to display anything); option B<+ss>.
701
702=item B<transparent:> I<boolean>
703
704Turn on/off illusion of a transparent window background.
705
706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
707future versions.
591 708
592=item B<fading:> I<number> 709=item B<fading:> I<number>
593 710
594Fade the text by the given percentage when focus is lost; option B<-fade>. 711Fade the text by the given percentage when focus is lost; option B<-fade>.
595 712
603Tint the transparent background pixmap with the given colour; option 720Tint the transparent background pixmap with the given colour; option
604B<-tint>. 721B<-tint>.
605 722
606=item B<shading:> I<number> 723=item B<shading:> I<number>
607 724
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 725Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609image in addition to tinting it. 726in addition to tinting it; option B<-sh>.
727
728=item B<blendType:> I<string>
729
730Specify background blending type; option B<-blt>.
731
732=item B<blurRadius:> I<number>
733
734Apply gaussian blur with the specified radius to the transparent
735background image; option B<-blr>.
736
737=item B<iconFile:> I<file>
738
739Set the application icon pixmap; option B<-icon>.
610 740
611=item B<scrollColor:> I<colour> 741=item B<scrollColor:> I<colour>
612 742
613Use the specified colour for the scrollbar [default #B2B2B2]. 743Use the specified colour for the scrollbar [default #B2B2B2].
614 744
620=item B<borderColor:> I<colour> 750=item B<borderColor:> I<colour>
621 751
622The colour of the border around the text area and between the scrollbar 752The colour of the border around the text area and between the scrollbar
623and the text. 753and the text.
624 754
625=item B<backgroundPixmap:> I<file[;geom]> 755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626 756
627Use the specified XPM file (note the `.xpm' extension is optional) for 757Use the specified image file for the background and also
628the background and also optionally specify its scaling with a geometry 758optionally specify its scaling with a geometry string B<WxH+X+Y>,
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 759(default C<100x100+50+50>) in which B<"W" / "H"> specify the
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
631centre (percent). A scale of 0 displays the image with tiling. A scale 761centre (percent). A scale of 0 displays the image with tiling.
632of 1 displays the image without any scaling. A scale of 2 to 9 762The maximum permitted scale is 1000.
633specifies an integer number of images in that direction. No image will 763Additional operations can be specified after colon B<:op1:op2...>.
634be magnified beyond 10 times its original size. The maximum permitted 764Supported operations are:
635scale is 1000. [default 0x0+50+50] 765
766 tile force background image to be tiled and not scaled. Equivalent to 0x0
767 propscale will scale image keeping proportions
768 auto will scale image to match window size. Equivalent to 100x100
769 hscale will scale image horizontally to the window size
770 vscale will scale image vertically to the window size
771 scale will scale image to match window size
772 root will tile image as if it was a root window background, auto-adjusting
773 whenever terminal window moves
774
775If used in conjunction with B<-tr> option, the specified pixmap will be
776blended over transparency image using alpha-blending. If I<afterimage>
777support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option.
636 779
637=item B<path:> I<path> 780=item B<path:> I<path>
638 781
639Specify the colon-delimited search path for finding XPM files. 782Specify the colon-delimited search path for finding background image files.
640 783
641=item B<font:> I<fontlist> 784=item B<font:> I<fontlist>
642 785
643Select the fonts to be used. This is a comma separated list of font names 786Select the fonts to be used. This is a comma separated list of font names
644that are checked in order when trying to find glyphs for characters. The 787that are checked in order when trying to find glyphs for characters. The
667it is named first) and thus defines the character cell grid to be 9 pixels 810it is named first) and thus defines the character cell grid to be 9 pixels
668wide and 15 pixels high. 811wide and 15 pixels high.
669 812
670The second font is just used to add additional unicode characters not in 813The second font is just used to add additional unicode characters not in
671the base font, likewise the third, which is unfortunately non-bold, but 814the base font, likewise the third, which is unfortunately non-bold, but
672the bold version of the font does contain less characters, so this is a 815the bold version of the font does contain fewer characters, so this is a
673useful supplement. 816useful supplement.
674 817
675The third font is an Xft font with aliasing turned off, and the characters 818The third font is an Xft font with aliasing turned off, and the characters
676are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 819are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
677contains other characters, but we are not interested in them. 820contains other characters, but we are not interested in them.
701text font will being used for the given style. 844text font will being used for the given style.
702 845
703=item B<intensityStyles:> I<boolean> 846=item B<intensityStyles:> I<boolean>
704 847
705When font styles are not enabled, or this option is enabled (B<True>, 848When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 849option B<-is>, the default), bold/blink font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 850intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 851option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 852reachable.
710
711=item B<selectstyle:> I<mode>
712
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is
714xterm style with 2.20 old word selection, or anything else which gives
715xterm style selection.
716
717=item B<scrollstyle:> I<mode>
718
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite.
721 853
722=item B<title:> I<string> 854=item B<title:> I<string>
723 855
724Set window title string, the default title is the command-line 856Set window title string, the default title is the command-line
725specified after the B<-e> option, if any, otherwise the application 857specified after the B<-e> option, if any, otherwise the application
734=item B<mapAlert:> I<boolean> 866=item B<mapAlert:> I<boolean>
735 867
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 868B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 869de-iconify (map) on receipt of a bell character [default].
738 870
871=item B<urgentOnBell:> I<boolean>
872
873B<True>: set the urgency hint for the wm on receipt of a bell character.
874B<False>: do not set the urgency hint [default].
875
876@@RXVT_NAME@@ resets the urgency hint on every focus change.
877
739=item B<visualBell:> I<boolean> 878=item B<visualBell:> I<boolean>
740 879
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 880B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 881B<False>: no visual bell [default]; option B<+vb>.
743 882
764Example: 903Example:
765 904
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 905 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 906
768This creates a new file in your home directory with the screen contents 907This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 908every time you hit C<Print>.
909
910=item B<scrollstyle:> I<mode>
911
912Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
913the author's favourite.
770 914
771=item B<scrollBar:> I<boolean> 915=item B<scrollBar:> I<boolean>
772 916
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 917B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 918disable the scrollbar; option B<+sb>.
796 940
797=item B<scrollWithBuffer:> I<boolean> 941=item B<scrollWithBuffer:> I<boolean>
798 942
799B<True>: scroll with scrollback buffer when tty receives new lines (and 943B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 944B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 945with scrollback buffer when tty receives new lines; option B<+sw>.
802 946
803=item B<scrollTtyKeypress:> I<boolean> 947=item B<scrollTtyKeypress:> I<boolean>
804 948
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 949B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 950are those which are intercepted by rxvt-unicode for special handling and
837=item B<termName:> I<termname> 981=item B<termName:> I<termname>
838 982
839Specifies the terminal type name to be set in the B<TERM> environment 983Specifies the terminal type name to be set in the B<TERM> environment
840variable; option B<-tn>. 984variable; option B<-tn>.
841 985
842=item B<linespace:> I<number> 986=item B<lineSpace:> I<number>
843 987
844Specifies number of lines (pixel height) to insert between each row of 988Specifies number of lines (pixel height) to insert between each row of
845the display [default 0]; option B<-lsp>. 989the display [default 0]; option B<-lsp>.
846 990
847=item B<meta8:> I<boolean> 991=item B<meta8:> I<boolean>
861 1005
862=item B<cursorBlink:> I<boolean> 1006=item B<cursorBlink:> I<boolean>
863 1007
864B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1008B<True>: blink the cursor. B<False>: do not blink the cursor [default];
865option B<-bc>. 1009option B<-bc>.
1010
1011=item B<cursorUnderline:> I<boolean>
1012
1013B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1014option B<-uc>.
866 1015
867=item B<pointerBlank:> I<boolean> 1016=item B<pointerBlank:> I<boolean>
868 1017
869B<True>: blank the pointer when a key is pressed or after a set number 1018B<True>: blank the pointer when a key is pressed or after a set number
870of seconds of inactivity. B<False>: the pointer is always visible 1019of seconds of inactivity. B<False>: the pointer is always visible
884large number (e.g. C<987654321>) to effectively disable the timeout. 1033large number (e.g. C<987654321>) to effectively disable the timeout.
885 1034
886=item B<backspacekey:> I<string> 1035=item B<backspacekey:> I<string>
887 1036
888The string to send when the backspace key is pressed. If set to B<DEC> 1037The string to send when the backspace key is pressed. If set to B<DEC>
889or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1038or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
890(code 8) - which can be reversed with the appropriate DEC private mode 1039(code 8) - which can be reversed with the appropriate DEC private mode
891escape sequence. 1040escape sequence.
892 1041
893=item B<deletekey:> I<string> 1042=item B<deletekey:> I<string>
894 1043
896pressed. If unset it will send the sequence traditionally associated 1045pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 1046with the B<Execute> key.
898 1047
899=item B<cutchars:> I<string> 1048=item B<cutchars:> I<string>
900 1049
901The characters used as delimiters for double-click word selection. The 1050The characters used as delimiters for double-click word selection
902built-in default: 1051(whitespace delimiting is added automatically if resource is given).
903 1052
1053When the perl selection extension is in use (the default if compiled
1054in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1055characters will be created (if the resource exists, otherwise, no regex
1056will be created). In this mode, characters outside ISO-8859-1 can be used.
1057
1058When the selection extension is not used, only ISO-8859-1 characters can
1059be used. If not specified, the built-in default is used:
1060
904B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1061B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
905 1062
906=item B<preeditType:> I<style> 1063=item B<preeditType:> I<style>
907 1064
908B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1065B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
909 1066
963 1120
964Turn on/off secondary screen (default enabled). 1121Turn on/off secondary screen (default enabled).
965 1122
966=item B<secondaryScroll:> I<boolean> 1123=item B<secondaryScroll:> I<boolean>
967 1124
968Turn on/off secondary screen scroll (default enabled). If the this 1125Turn on/off secondary screen scroll (default enabled). If this
969option is enabled, scrolls on the secondary screen will change the 1126option is enabled, scrolls on the secondary screen will change the
970scrollback buffer and switching to/from the secondary screen will 1127scrollback buffer and, when secondaryScreen is off, switching
971instead scroll the screen up. 1128to/from the secondary screen will instead scroll the screen up.
972 1129
973=item B<hold>: I<boolean> 1130=item B<hold>: I<boolean>
974 1131
975Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1132Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
976will not immediately destroy its window when the program executed within 1133will not immediately destroy its window when the program executed within
977it exits. Instead, it will wait till it is being killed or closed by the 1134it exits. Instead, it will wait till it is being killed or closed by the
978user. 1135user.
1136
1137=item B<chdir>: I<path>
1138
1139Sets the working directory for the shell (or the command specified via
1140B<-e>). The I<path> must be an absolute path and it must exist for
1141@@RXVT_NAME@@ to start. If it isn't specified then the current working
1142directory will be used; option B<-cd>.
979 1143
980=item B<keysym.>I<sym>: I<string> 1144=item B<keysym.>I<sym>: I<string>
981 1145
982Compile I<frills>: Associate I<string> with keysym I<sym>. The 1146Compile I<frills>: Associate I<string> with keysym I<sym>. The
983intervening resource name B<keysym.> cannot be omitted. 1147intervening resource name B<keysym.> cannot be omitted.
997searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1161searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
998omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1162omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
999keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1163keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1000performed in an exact manner; however, the closest match is assured. 1164performed in an exact manner; however, the closest match is assured.
1001 1165
1002I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1003C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1167number), see RESOURCES in C<man 7 X> for further details.
1004C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1005C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1006can start or end with whitespace.
1007
1008Please note that you need to double the C<\> in resource files, as
1009Xlib itself does it's own de-escaping (you can use C<\033> instead of
1010C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1011processing).
1012 1168
1013You can define a range of keysyms in one shot by providing a I<string> 1169You can define a range of keysyms in one shot by providing a I<string>
1014with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1015should be a character not used by the strings. 1171should be a character not used by the strings.
1016 1172
1017Its usage can be demonstrated by an example: 1173Its usage can be demonstrated by an example:
1018 1174
1019 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1175 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1030when Control-Meta-c is being pressed": 1186when Control-Meta-c is being pressed":
1031 1187
1032 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1188 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1033 1189
1034If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1190If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1035is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1191is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1036manpage. For example, the F<selection> extension (activated via 1192manpage. For example, the F<selection> extension (activated via
1037C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1038 1194
1039 URxvt.keysym.M-C-c: perl:selection:rot13 1195 URxvt.keysym.M-C-c: perl:selection:rot13
1040 1196
1041Due the the large number of modifier combinations, a defined key mapping 1197Due the the large number of modifier combinations, a defined key mapping
1042will match if at I<at least> the specified identifiers are being set, and 1198will match if I<at least> the specified identifiers are being set, and
1043no other key mappings with those and more bits are being defined. That 1199no other key mappings with those and more bits are being defined. That
1044means that defining a key map for C<a> will automatically provide 1200means that defining a key map for C<a> will automatically provide
1045definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1201definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1046mappings themselves. 1202mappings themselves.
1047 1203
1083example, C<default,-selection> will use all the default extension except 1239example, C<default,-selection> will use all the default extension except
1084C<selection>. 1240C<selection>.
1085 1241
1086Extension names can also be followed by an argument in angle brackets 1242Extension names can also be followed by an argument in angle brackets
1087(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1243(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088searchable scorllback to Alt/Meta-s). Mentioning the same extension 1244searchable scrollback to Alt/Meta-s). Mentioning the same extension
1089multiple times with different arguments will pass multiple arguments to 1245multiple times with different arguments will pass multiple arguments to
1090the extension. 1246the extension.
1091 1247
1092Each extension is looked up in the library directories, loaded if 1248Each extension is looked up in the library directories, loaded if
1093necessary, and bound to the current terminal instance. 1249necessary, and bound to the current terminal instance.
1098all instances, while B<perl-ext> is used for specific instances. 1254all instances, while B<perl-ext> is used for specific instances.
1099 1255
1100=item B<perl-eval>: I<string> 1256=item B<perl-eval>: I<string>
1101 1257
1102Perl code to be evaluated when all extensions have been registered. See 1258Perl code to be evaluated when all extensions have been registered. See
1103the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1259the @@RXVT_NAME@@perl(3) manpage.
1104will be ignored when running setuid/setgid.
1105 1260
1106=item B<perl-lib>: I<path> 1261=item B<perl-lib>: I<path>
1107 1262
1108Colon-separated list of additional directories that hold extension 1263Colon-separated list of additional directories that hold extension
1109scripts. When looking for extensions specified by the C<perl> resource, 1264scripts. When looking for extensions specified by the C<perl> resource,
1110@@RXVT_NAME@@ will first look in these directories and then in 1265@@RXVT_NAME@@ will first look in these directories and then in
1111F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1266F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1112will be ignored when running setuid/setgid.
1113 1267
1114See the @@RXVT_NAME@@perl(3) manpage. 1268See the @@RXVT_NAME@@perl(3) manpage.
1115 1269
1116=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1270=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1117 1271
1129(default: C<M-s>). 1283(default: C<M-s>).
1130 1284
1131=item B<urlLauncher>: I<string> 1285=item B<urlLauncher>: I<string>
1132 1286
1133Specifies the program to be started with a URL argument. Used by the 1287Specifies the program to be started with a URL argument. Used by the
1134C<selection-popup> and C<mark-urls> perl extensions. 1288C<selection-popup> and C<matcher> perl extensions.
1135 1289
1136=item B<transient-for>: I<windowid> 1290=item B<transient-for>: I<windowid>
1137 1291
1138Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1292Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139 1293
1140=item B<override-redirect>: I<boolean> 1294=item B<override-redirect>: I<boolean>
1141 1295
1142Compile I<frills>: Sets override-redirect for the terminal window, making 1296Compile I<frills>: Sets override-redirect for the terminal window, making
1143it almost invisible to window managers; option B<-override-redirect>. 1297it almost invisible to window managers; option B<-override-redirect>.
1298
1299=item B<iso14755:> I<boolean>
1300
1301Turn on/off ISO 14755 (default enabled).
1302
1303=item B<iso14755_52:> I<boolean>
1304
1305Turn on/off ISO 14755 5.2 mode (default enabled).
1144 1306
1145=back 1307=back
1146 1308
1147=head1 THE SCROLLBAR 1309=head1 THE SCROLLBAR
1148 1310
1167application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1329application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1168(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1330(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1169up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1331up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1170respectively. 1332respectively.
1171 1333
1172=head1 TEXT SELECTION AND INSERTION 1334=head1 THE SELECTION: SELECTING AND PASTING TEXT
1173 1335
1174The behaviour of text selection and insertion mechanism is similar to 1336The behaviour of text selection and insertion/pasting mechanism is similar
1175I<xterm>(1). 1337to I<xterm>(1).
1176 1338
1177=over 4 1339=over 4
1178 1340
1179=item B<Selection>: 1341=item B<Selecting>:
1180 1342
1181Left click at the beginning of the region, drag to the end of the region 1343Left click at the beginning of the region, drag to the end of the region
1182and release; Right click to extend the marked region; Left double-click 1344and release; Right click to extend the marked region; Left double-click
1183to select a word; Left triple-click to select the entire logical line 1345to select a word; Left triple-click to select the entire logical line
1184(which can span multiple screen lines), unless modified by resource 1346(which can span multiple screen lines), unless modified by resource
1188(Compile: I<frills>) will create a rectangular selection instead of a 1350(Compile: I<frills>) will create a rectangular selection instead of a
1189normal one. In this mode, every selected row becomes its own line in the 1351normal one. In this mode, every selected row becomes its own line in the
1190selection, and trailing whitespace is visually underlined and removed from 1352selection, and trailing whitespace is visually underlined and removed from
1191the selection. 1353the selection.
1192 1354
1193=item B<Insertion>: 1355=item B<Pasting>:
1194 1356
1195Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1357Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1196an B<@@RXVT_NAME@@> window causes the current text selection to be 1358window causes the value of the PRIMARY selection (or CLIPBOARD with the
1197inserted as if it had been typed on the keyboard. 1359B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1360
1361Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1362inserted too.
1198 1363
1199=back 1364=back
1200 1365
1201=head1 CHANGING FONTS 1366=head1 CHANGING FONTS
1202 1367
1216 1381
1217=head1 ISO 14755 SUPPORT 1382=head1 ISO 14755 SUPPORT
1218 1383
1219ISO 14755 is a standard for entering and viewing unicode characters 1384ISO 14755 is a standard for entering and viewing unicode characters
1220and character codes using the keyboard. It consists of 4 parts. The 1385and character codes using the keyboard. It consists of 4 parts. The
1221first part is available rxvt-unicode has been compiled with 1386first part is available if rxvt-unicode has been compiled with
1222C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1387C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1223with C<--enable-iso14755>. 1388with C<--enable-iso14755>.
1224 1389
1225=over 4 1390=over 4
1226 1391
1246This mode lets you input characters representing the keycap symbols of 1411This mode lets you input characters representing the keycap symbols of
1247your keyboard, if representable in the current locale encoding. 1412your keyboard, if representable in the current locale encoding.
1248 1413
1249Start by pressing C<Control> and C<Shift> together, then releasing 1414Start by pressing C<Control> and C<Shift> together, then releasing
1250them. The next special key (cursor keys, home etc.) you enter will not 1415them. The next special key (cursor keys, home etc.) you enter will not
1251invoke it's usual function but instead will insert the corresponding 1416invoke its usual function but instead will insert the corresponding
1252keycap symbol. The symbol will only be entered when the key has been 1417keycap symbol. The symbol will only be entered when the key has been
1253released, otherwise pressing e.g. C<Shift> would enter the symbol for 1418released, otherwise pressing e.g. C<Shift> would enter the symbol for
1254C<ISO Level 2 Switch>, although your intention might have been to enter a 1419C<ISO Level 2 Switch>, although your intention might have been to enter a
1255reverse tab (Shift-Tab). 1420reverse tab (Shift-Tab).
1256 1421
1284B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1449B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1285it can be seen via the I<who(1)> command, and can accept messages. To 1450it can be seen via the I<who(1)> command, and can accept messages. To
1286allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1451allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1287on some systems or setgid to root or to some other group on others. 1452on some systems or setgid to root or to some other group on others.
1288 1453
1289=head1 COLORS AND GRAPHICS 1454=head1 COLOURS AND GRAPHICS
1290 1455
1291In addition to the default foreground and background colours, 1456In addition to the default foreground and background colours,
1292B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1457B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1293high-intensity bold/blink versions of the same). Here is a list of the 1458high-intensity (potentially bold/blink) versions of the same, and 72 (or
1294colours with their B<rgb.txt> names. 1459240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1460cube plus a 8 (24) colour greyscale ramp.
1461
1462Here is a list of the ANSI colours with their names.
1295 1463
1296=begin table 1464=begin table
1297 1465
1298 B<color0> (black) = Black 1466 B<color0> (black) = Black
1299 B<color1> (red) = Red3 1467 B<color1> (red) = Red3
1319It is also possible to specify the colour values of B<foreground>, 1487It is also possible to specify the colour values of B<foreground>,
1320B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1488B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1321a number 0-15, as a convenient shorthand to reference the colour name of 1489a number 0-15, as a convenient shorthand to reference the colour name of
1322color0-color15. 1490color0-color15.
1323 1491
1492The following text gives values for the standard 88 colour mode (and
1493values for the 256 colour mode in parentheses).
1494
1495The RGB cube uses indices 16..79 (16..231) using the following formulas:
1496
1497 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1498 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1499
1500The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1501steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1502the RGB cube.
1503
1504Together, all those colours implement the 88 (256) colour xterm
1505colours. Only the first 16 can be changed using resources currently, the
1506rest can only be changed via command sequences ("escape codes").
1507
1508Applications are advised to use terminfo or command sequences to discover
1509number and RGB values of all colours (yes, you can query this...).
1510
1324Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1511Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1325always swapping the foreground/background colours. This is in contrast to 1512always swapping the foreground/background colours. This is in contrast to
1326I<xterm>(1) where the colours are only swapped if they have not otherwise 1513I<xterm>(1) where the colours are only swapped if they have not otherwise
1327been specified. For example, 1514been specified. For example,
1328 1515
1516 @@RXVT_NAME@@ -fg Black -bg White -rv
1517
1518would yield White on Black, while on I<xterm>(1) it would yield Black on
1519White.
1520
1521=head2 ALPHA CHANNEL SUPPORT
1522
1523If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1524their act together, rxvt-unicode will do it's own alpha channel management:
1525
1526You can prefix any colour with an opaqueness percentage enclosed in
1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1528(0-100) that specifies the opacity of the colour, where C<0> is completely
1529transparent and C<100> is completely opaque. For example, C<[50]red> is a
1530half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1531is the recommended format to specify transparency values, and works with
1532all ways to specify a colour.
1533
1534For complete control, rxvt-unicode also supports
1535C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1536specifications, where the additional C<aaaa> component specifies opacity
1537(alpha) values. The minimum value of C<0000> is completely transparent,
1538while C<ffff> is completely opaque). The two example colours from
1539earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1540C<rgba:0000/ff00/0000/f332>.
1541
1542You probably need to specify B<"-depth 32">, too, to force a visual with
1543alpha channels, and have the luck that your X-server uses ARGB pixel
1544layout, as X is far from just supporting ARGB visuals out of the box, and
1545rxvt-unicode just fudges around.
1546
1547For example, the following selects an almost completely transparent black
1548background, and an almost opaque pink foreground:
1549
1550 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1551
1552When not using a background image, then the interpretation of the
1553alpha channel is up to your compositing manager (most interpret it as
1554transparency of course).
1555
1556When using a background pixmap or pseudo-transparency, then the background
1557colour will always behave as if it were completely transparent (so the
1558background image shows instead), regardless of how it was specified, while
1559other colours will either be transparent as specified (the background
1560image will show through) on servers supporting the RENDER extension, or
1561fully opaque on servers not supporting the RENDER EXTENSION.
1562
1563Please note that due to bugs in Xft, specifying alpha values might result
1564in garbage being displayed when the X-server does not support the RENDER
1565extension.
1566
1567=head1 ENVIRONMENT
1568
1569B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1570
1329=over 4 1571=over 4
1330 1572
1331=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1332
1333would yield White on Black, while on I<xterm>(1) it would yield Black
1334on White.
1335
1336=back
1337
1338=head1 ENVIRONMENT
1339
1340B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1341
1342=over 4
1343
1344=item B<TERM> 1573=item B<TERM>
1345 1574
1346Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1575Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1347resources or on the commandline. 1576resources or on the command line.
1348 1577
1349=item B<COLORTERM> 1578=item B<COLORTERM>
1350 1579
1351Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1580Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1352compiled with XPM support, and optionally with the added extension 1581compiled with background image support, and optionally with the added
1353C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1582extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1583screen.
1354 1584
1355=item B<COLORFGBG> 1585=item B<COLORFGBG>
1356 1586
1357Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1587Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1358the colour code used as default foreground/text colour (or the string 1588the colour code used as default foreground/text colour (or the string
1359C<default> to indicate that the default-colour escape sequence is to be 1589C<default> to indicate that the default-colour escape sequence is to be
1360used), C<bg> is the colour code used as default background colour (or the 1590used), C<bg> is the colour code used as default background colour (or the
1361string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1591string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1362was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1592was compiled with background image support. Libraries like C<ncurses>
1363(and do) use this information to optimize screen output. 1593and C<slang> can (and do) use this information to optimize screen output.
1364 1594
1365=item B<WINDOWID> 1595=item B<WINDOWID>
1366 1596
1367Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1597Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1368window, which usually has subwindows for the scrollbar, the terminal 1598window, which usually has subwindows for the scrollbar, the terminal
1374C<--with-terminfo=PATH>. 1604C<--with-terminfo=PATH>.
1375 1605
1376=item B<DISPLAY> 1606=item B<DISPLAY>
1377 1607
1378Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1608Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1379display in it's child processes. 1609display in its child processes if C<-display> isn't used to override. It
1610defaults to C<:0> if it doesn't exist.
1380 1611
1381=item B<SHELL> 1612=item B<SHELL>
1382 1613
1383The shell to be used for command execution, defaults to C</bin/sh>. 1614The shell to be used for command execution, defaults to C</bin/sh>.
1384 1615
1410 1641
1411=over 4 1642=over 4
1412 1643
1413=item B</usr/lib/X11/rgb.txt> 1644=item B</usr/lib/X11/rgb.txt>
1414 1645
1415Color names. 1646Colour names.
1416 1647
1417=back 1648=back
1418 1649
1419=head1 SEE ALSO 1650=head1 SEE ALSO
1420 1651
1426 1657
1427=item Project Coordinator 1658=item Project Coordinator
1428 1659
1429Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1660Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1430 1661
1431L<http://software.schmorp.de/#rxvt-unicode> 1662L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1432 1663
1433=back 1664=back
1434 1665
1435=head1 AUTHORS 1666=head1 AUTHORS
1436 1667
1459Project Coordinator (changes.txt 2.21a to 2.4.5) 1690Project Coordinator (changes.txt 2.21a to 2.4.5)
1460 1691
1461=item Geoff Wing L<< <gcw@pobox.com> >> 1692=item Geoff Wing L<< <gcw@pobox.com> >>
1462 1693
1463Rewrote screen display and text selection routines. 1694Rewrote screen display and text selection routines.
1464 1695
1465Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1696Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1466 1697
1467=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1698=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1468 1699
1469Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1700Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1471 1702
1472Project Coordinator (Changes 1.0 -) 1703Project Coordinator (Changes 1.0 -)
1473 1704
1474=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1705=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1475 1706
1476Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugxifing. 1707Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1477 1708
1478=back 1709=back
1479 1710

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines