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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines