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.78 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC

… …
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
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 pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
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 with the given colour;
129transparency is enabled with B<-tr> or B<-ip>. This only works for 148resource I<tintColor>.
130non-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
132I<tintColor>. Example:
133 149
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 150=item B<-sh> I<number>
135 151
136=item B<-sh>
137
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
139background image in addition to tinting it (i.e. B<-tint> must be 153A value of 100 means no shading; resource I<shading>.
140specified, too, e.g. C<-tint white>). 154
155=item B<-blr> I<HxV>
156
157Apply Gaussian Blur with the specified radii to the transparent
158background. If a single number is specified, the vertical and
159horizontal radii are considered to be the same. Setting one of the
160radii to 1 and the other to a large number creates interesting effects
161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
163resource I<blurRadius>.
164
165=item B<-icon> I<file>
166
167Compile I<pixbuf>: Use the specified image as application icon. This
168is used by many window managers, taskbars and pagers to represent the
169application window; resource I<iconFile>.
141 170
142=item B<-bg> I<colour> 171=item B<-bg> I<colour>
143 172
144Window background colour; resource B<background>. 173Window background colour; resource B<background>.
145 174
146=item B<-fg> I<colour> 175=item B<-fg> I<colour>
147 176
148Window foreground colour; resource B<foreground>. 177Window foreground colour; resource B<foreground>.
149 178
150=item B<-pixmap> I<file[;geom]> 179=item B<-pixmap> I<file[;oplist]>
151 180
152Compile I<XPM>: Specify XPM file for the background and also optionally 181Compile I<pixbuf>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 182optionally specify a list of operations to modify it. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 183add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 184command-line; for more details see resource B<backgroundPixmap>.
156 185
157=item B<-cr> I<colour> 186=item B<-cr> I<colour>
158 187
159The cursor colour; resource B<cursorColor>. 188The cursor colour; resource B<cursorColor>.
160 189
… …
172resource B<borderColor>. 201resource B<borderColor>.
173 202
174=item B<-fn> I<fontlist> 203=item B<-fn> I<fontlist>
175 204
176Select the fonts to be used. This is a comma separated list of font names 205Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 206that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 207first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 208smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 209font list is always appended to it. See resource B<font> for more details.
181 210
182In short, to specify an X11 core font, just specify it's name or prefix it 211In 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:>, 212with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 213e.g.:
185 214
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 215 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 216 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
… …
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 218See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 219section of @@RXVT_NAME@@(7).
191 220
192=item B<-fb> I<fontlist> 221=item B<-fb> I<fontlist>
193 222
194Compile font-styles: The bold font list to use when bold characters are to 223Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 224are to be printed. See resource B<boldFont> for details.
196 225
197=item B<-fi> I<fontlist> 226=item B<-fi> I<fontlist>
198 227
199Compile font-styles: The italic font list to use when bold characters are to 228Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 229characters are to be printed. See resource B<italicFont> for details.
201 230
202=item B<-fbi> I<fontlist> 231=item B<-fbi> I<fontlist>
203 232
204Compile font-styles: The bold italic font list to use when bold characters are to 233Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 234italic> >> characters are to be printed. See resource B<boldItalicFont>
235for details.
206 236
207=item B<-is>|B<+is> 237=item B<-is>|B<+is>
208 238
209Compile font-styles: Bold/Italic font styles imply high intensity 239Compile I<font-styles>: Bold/Blink font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for 240foreground/background (default). See resource B<intensityStyles> for
211details. 241details.
212 242
213=item B<-name> I<name> 243=item B<-name> I<name>
214 244
… …
232 262
233=item B<-sb>|B<+sb> 263=item B<-sb>|B<+sb>
234 264
235Turn on/off scrollbar; resource B<scrollBar>. 265Turn on/off scrollbar; resource B<scrollBar>.
236 266
267=item B<-sr>|B<+sr>
268
269Put scrollbar on right/left; resource B<scrollBar_right>.
270
271=item B<-st>|B<+st>
272
273Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
274resource B<scrollBar_floating>.
275
237=item B<-si>|B<+si> 276=item B<-si>|B<+si>
238 277
239Turn on/off scroll-to-bottom on TTY output inhibit; resource 278Turn on/off scroll-to-bottom on TTY output inhibit; resource
240B<scrollTtyOutput> has opposite effect. 279B<scrollTtyOutput> has opposite effect.
241 280
… …
247=item B<-sw>|B<+sw> 286=item B<-sw>|B<+sw>
248 287
249Turn on/off scrolling with the scrollback buffer as new lines appear. 288Turn on/off scrolling with the scrollback buffer as new lines appear.
250This only takes effect if B<-si> is also given; resource 289This only takes effect if B<-si> is also given; resource
251B<scrollWithBuffer>. 290B<scrollWithBuffer>.
252
253=item B<-sr>|B<+sr>
254
255Put scrollbar on right/left; resource B<scrollBar_right>.
256
257=item B<-st>|B<+st>
258
259Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
260resource B<scrollBar_floating>.
261 291
262=item B<-ptab>|B<+ptab> 292=item B<-ptab>|B<+ptab>
263 293
264If enabled (default), "Horizontal Tab" characters are being stored as 294If enabled (default), "Horizontal Tab" characters are being stored as
265actual wide characters in the screen buffer, which makes it possible to 295actual wide characters in the screen buffer, which makes it possible to
… …
269 299
270=item B<-bc>|B<+bc> 300=item B<-bc>|B<+bc>
271 301
272Blink the cursor; resource B<cursorBlink>. 302Blink the cursor; resource B<cursorBlink>.
273 303
304=item B<-uc>|B<+uc>
305
306Make the cursor underlined; resource B<cursorUnderline>.
307
274=item B<-iconic> 308=item B<-iconic>
275 309
276Start iconified, if the window manager supports that option. 310Start iconified, if the window manager supports that option.
277Alternative form is B<-ic>. 311Alternative form is B<-ic>.
278 312
… …
294 328
295=item B<-bl> 329=item B<-bl>
296 330
297Compile I<frills>: Set MWM hints to request a borderless window, i.e. 331Compile I<frills>: Set MWM hints to request a borderless window, i.e.
298if honoured by the WM, the rxvt-unicode window will not have window 332if honoured by the WM, the rxvt-unicode window will not have window
299decorations; resource B<borderLess>. 333decorations; resource B<borderLess>. If the window manager does not
334support MWM hints (e.g. kwin), enables override-redirect mode.
335
336=item B<-override-redirect>
337
338Compile I<frills>: Sets override-redirect on the window; resource
339B<override-redirect>.
340
341=item B<-sbg>
342
343Compile I<frills>: Disable the usage of the built-in block graphics/line
344drawing characters and just rely on what the specified fonts provide. Use
345this if you have a good font and want to use its block graphic glyphs;
346resource B<skipBuiltinGlyphs>.
300 347
301=item B<-lsp> I<number> 348=item B<-lsp> I<number>
302 349
303Compile I<frills>: Lines (pixel height) to insert between each row of 350Compile I<frills>: Lines (pixel height) to insert between each row of
304the display. Useful to work around font rendering problems; resource 351the display. Useful to work around font rendering problems; resource
305B<linespace>. 352B<lineSpace>.
353
354=item B<-letsp> I<number>
355
356Compile I<frills>: Amount to adjust the computed character width by
357to control overall letter spacing. Negative values will tighten up the
358letter spacing, positive values will space letters out more. Useful to
359work around odd font metrics; resource B<letterSpace>.
306 360
307=item B<-tn> I<termname> 361=item B<-tn> I<termname>
308 362
309This option specifies the name of the terminal type to be set in the 363This option specifies the name of the terminal type to be set in the
310B<TERM> environment variable. This terminal type must exist in the 364B<TERM> environment variable. This terminal type must exist in the
… …
364for more info. 418for more info.
365 419
366=item B<-tcw> 420=item B<-tcw>
367 421
368Change the meaning of triple-click selection with the left mouse 422Change the meaning of triple-click selection with the left mouse
423button. Only effective when the original (non-perl) selection code is
369button. Instead of selecting a full line it will extend the selection the 424in-use. Instead of selecting a full line it will extend the selection to
370end of the logical line only. resource B<tripleclickwords>. 425the end of the logical line only. resource B<tripleclickwords>.
371 426
372=item B<-insecure> 427=item B<-insecure>
373 428
374Enable "insecure" mode, which currently enables most of the escape 429Enable "insecure" mode, which currently enables most of the escape
375sequences that echo strings. See the resource B<insecure> for more 430sequences that echo strings. See the resource B<insecure> for more
… …
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 451Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within 452will not immediately destroy its window when the program executed within
398it exits. Instead, it will wait till it is being killed or closed by the 453it exits. Instead, it will wait till it is being killed or closed by the
399user; resource B<hold>. 454user; resource B<hold>.
400 455
456=item B<-cd> I<path>
457
458Sets the working directory for the shell (or the command specified via
459B<-e>). The I<path> must be an absolute path and it must exist for
460@@RXVT_NAME@@ to start; resource B<chdir>.
461
462=item B<-xrm> I<string>
463
464Works like the X Toolkit option of the same name, by adding the I<string>
465as if it were specified in a resource file. Resource values specified this
466way take precedence over all other resource specifications.
467
468Note that you need to use the I<same> syntax as in the .Xdefaults file,
469e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
470options can be specified as long-options on the commandline, so use
471of B<-xrm> is mostly limited to cases where you want to specify other
472resources (e.g. for input methods) or for compatibility with other
473programs.
474
401=item B<-keysym.>I<sym> I<string> 475=item B<-keysym.>I<sym> I<string>
402 476
403Remap a key symbol. See resource B<keysym>. 477Remap a key symbol. See resource B<keysym>.
404 478
405=item B<-embed> I<windowid> 479=item B<-embed> I<windowid>
406 480
407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 481Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408which enables applications to easily embed a terminal. 482which enables applications to easily embed a terminal.
409 483
410Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 484Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
411shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 485shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
412quite a bit, so don't expect it to keep some specific state. It's best to 486quite a bit, so don't expect it to keep some specific state. It's best to
… …
415The window will not be destroyed when @@RXVT_NAME@@ exits. 489The window will not be destroyed when @@RXVT_NAME@@ exits.
416 490
417It might be useful to know that @@RXVT_NAME@@ will not close file 491It might be useful to know that @@RXVT_NAME@@ will not close file
418descriptors passed to it (except for stdin/out/err, of course), so you 492descriptors passed to it (except for stdin/out/err, of course), so you
419can use file descriptors to communicate with the programs within the 493can use file descriptors to communicate with the programs within the
420terminal. This works regardless of wether the C<-embed> option was used or 494terminal. This works regardless of whether the C<-embed> option was used or
421not. 495not.
422 496
423Here is a short Gtk2-perl snippet that illustrates how this option can be 497Here is a short Gtk2-perl snippet that illustrates how this option can be
424used (a longer example is in F<doc/embed>): 498used (a longer example is in F<doc/embed>):
425 499
… …
427 $rxvt->signal_connect_after (realize => sub { 501 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid; 502 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &"; 503 system "@@RXVT_NAME@@ -embed $xid &";
430 }); 504 });
431 505
432=item B<-pty-fd> I<fileno> 506=item B<-pty-fd> I<file descriptor>
433 507
434Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 508Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435pair but instead use the given filehandle as the tty master. This is 509pair but instead use the given file descriptor as the tty master. This is
436useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 510useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437without having to run a program within it. 511without having to run a program within it.
438 512
439If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 513If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440entries and will not tinker with pty/tty permissions - you have to do that 514entries and will not tinker with pty/tty permissions - you have to do that
441yourself if you want that. 515yourself if you want that.
516
517As an extremely special case, specifying C<-1> will completely suppress
518pty/tty operations, which is probably only useful in conjunction with some
519perl extension that manages the terminal.
442 520
443Here is a example in perl that illustrates how this option can be used (a 521Here is a example in perl that illustrates how this option can be used (a
444longer example is in F<doc/pty-fd>): 522longer example is in F<doc/pty-fd>):
445 523
446 use IO::Pty; 524 use IO::Pty;
… …
455 my $slave = $pty->slave; 533 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" } 534 while (<$slave>) { print $slave "got <$_>\n" }
457 535
458=item B<-pe> I<string> 536=item B<-pe> I<string>
459 537
460Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>. 538Comma-separated list of perl extension scripts to use (or not to use) in
539this terminal instance. See resource B<perl-ext> for details.
461 540
462=back 541=back
463 542
464=head1 RESOURCES (available also as long-options) 543=head1 RESOURCES
465 544
466Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 545Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
467options) compiled into your version. 546options) compiled into your version. All resources are also available as
547long-options.
468 548
469There are two different methods that @@RXVT_NAME@@ can use to get the 549You can set and change the resources using X11 tools like B<xrdb>. Many
470Xresource data: using the X libraries (Xrm*-functions) or internal 550distribution do also load settings from the B<~/.Xresources> file when X
471Xresources reader (B<~/.Xdefaults>). For the first method (ie. 551starts. @@RXVT_NAME@@ will consult the following files/resources in order,
472B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 552with later settings overwriting earlier ones:
473resources using X11 tools like B<xrdb>. Many distribution do also load
474settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475will consult the following files/resources in order, with later settings
476overwriting earlier ones:
477 553
478 1. system-wide app-defaults file, either locale-dependent OR global
479 2. app-defaults file in $XAPPLRESDIR 554 1. app-defaults file in $XAPPLRESDIR
555 2. $HOME/.Xdefaults
480 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 556 3. RESOURCE_MANAGER property on root-window of screen 0
481 4. SCREEN_RESOURCES for the current screen 557 4. SCREEN_RESOURCES property on root-window of the current screen
482 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 558 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
559 6. resources specified via -xrm on the commandline
483 560
484If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
485lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
486set in XAPPLOADDIR/URxvt (compile-time defined: usually
487B</usr/lib/X11/app-defaults/URxvt>) and resources set in
488B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
489Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 561Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
490class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 562names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
491resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 563common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
492easily configured, while the class name B<URxvt> allows resources 564configured, while the class name B<URxvt> allows resources unique to
493unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 565B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
494shared between different B<@@RXVT_NAME@@> configurations. If no 566configurations. If no resources are specified, suitable defaults will
495resources are specified, suitable defaults will be used. Command-line 567be used. Command-line arguments can be used to override resource
496arguments can be used to override resource settings. The following 568settings. The following resources are supported (you might want to
497resources are allowed: 569check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
570extensions not documented here):
498 571
499=over 4 572=over 4
573
574=item B<depth:> I<bitdepth>
575
576Compile I<xft>: Attempt to find a visual with the given bit depth;
577option B<-depth>.
578
579=item B<buffered:> I<boolean>
580
581Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
582On some card/driver combination enabling it slightly decreases
583performance, on most it greatly helps it. The slowdown is small, so it
584should normally be enabled.
500 585
501=item B<geometry:> I<geom> 586=item B<geometry:> I<geom>
502 587
503Create the window with the specified X window geometry [default 80x24]; 588Create the window with the specified X window geometry [default 80x24];
504option B<-geometry>. 589option B<-geometry>.
… …
518Use the specified colour for the colour value I<n>, where 0-7 603Use the specified colour for the colour value I<n>, where 0-7
519corresponds to low-intensity (normal) colours and 8-15 corresponds to 604corresponds to low-intensity (normal) colours and 8-15 corresponds to
520high-intensity (bold = bright foreground, blink = bright background) 605high-intensity (bold = bright foreground, blink = bright background)
521colours. The canonical names are as follows: 0=black, 1=red, 2=green, 606colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5223=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6073=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
523names used are listed in the B<COLORS AND GRAPHICS> section. 608names used are listed in the B<COLOURS AND GRAPHICS> section.
524 609
525Colours higher than 15 cannot be set using resources (yet), but can be 610Colours higher than 15 cannot be set using resources (yet), but can be
526changed using an escape command (see @@RXVT_NAME@@(7)). 611changed using an escape command (see @@RXVT_NAME@@(7)).
527 612
528Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 613Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
539=item B<colorUL:> I<colour> 624=item B<colorUL:> I<colour>
540 625
541Use the specified colour to display underlined characters when the 626Use the specified colour to display underlined characters when the
542foreground colour is the default. 627foreground colour is the default.
543 628
544=item B<colorRV:> I<colour>
545
546Use the specified colour as the background for reverse video
547characters.
548
549=item B<underlineColor:> I<colour> 629=item B<underlineColor:> I<colour>
550 630
551If set, use the specified colour as the colour for the underline 631If set, use the specified colour as the colour for the underline
552itself. If unset, use the foreground colour. 632itself. If unset, use the foreground colour.
633
634=item B<highlightColor:> I<colour>
635
636If set, use the specified colour as the background for highlighted
637characters. If unset, use reverse video.
638
639=item B<highlightTextColor:> I<colour>
640
641If set and highlightColor is set, use the specified colour as the
642foreground for highlighted characters.
553 643
554=item B<cursorColor:> I<colour> 644=item B<cursorColor:> I<colour>
555 645
556Use the specified colour for the cursor. The default is to use the 646Use the specified colour for the cursor. The default is to use the
557foreground colour; option B<-cr>. 647foreground colour; option B<-cr>.
… …
564 654
565=item B<reverseVideo:> I<boolean> 655=item B<reverseVideo:> I<boolean>
566 656
567B<True>: simulate reverse video by foreground and background colours; 657B<True>: simulate reverse video by foreground and background colours;
568option B<-rv>. B<False>: regular screen colours [default]; option 658option B<-rv>. B<False>: regular screen colours [default]; option
569B<+rv>. See note in B<COLORS AND GRAPHICS> section. 659B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
570 660
571=item B<jumpScroll:> I<boolean> 661=item B<jumpScroll:> I<boolean>
572 662
573B<True>: specify that jump scrolling should be used. When scrolling 663B<True>: specify that jump scrolling should be used. When receiving lots
574quickly, fewer screen updates are performed [default]; option B<-j>. 664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
665has been read, resulting in fewer updates while still displaying every
666received line; option B<-j>.
667
575B<False>: specify that smooth scrolling should be used; option B<+j>. 668B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
669force a screen refresh on each new line it received; option B<+j>.
576 670
577=item B<inheritPixmap:> I<boolean> 671=item B<skipScroll:> I<boolean>
578 672
579B<True>: make the background inherit the parent windows' pixmap, giving 673B<True>: (the default) specify that skip scrolling should be used. When
580artificial transparency. B<False>: do not inherit the parent windows' 674receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
581pixmap. 675(around 60 times per second), resulting in far fewer updates. This can
676result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
677option B<-ss>.
678
679B<False>: specify that everything is to be displayed, even
680if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>.
682
683=item B<transparent:> I<boolean>
684
685Turn on/off pseudo-transparency by using the root pixmap as background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
582 689
583=item B<fading:> I<number> 690=item B<fading:> I<number>
584 691
585Fade the text by the given percentage when focus is lost; option B<-fade>. 692Fade the text by the given percentage when focus is lost; option B<-fade>.
586 693
… …
589Fade to this colour, when fading is used (see B<fading:>). The default 696Fade to this colour, when fading is used (see B<fading:>). The default
590colour is black; option B<-fadecolor>. 697colour is black; option B<-fadecolor>.
591 698
592=item B<tintColor:> I<colour> 699=item B<tintColor:> I<colour>
593 700
594Tint the transparent background pixmap with the given colour; option 701Tint the transparent background with the given colour. If the RENDER
595B<-tint>. 702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
596 706
597=item B<shading:> I<number> 707=item B<shading:> I<number>
598 708
599Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
600image in addition to tinting it. 710A value of 100 means no shading; option B<-sh>.
711
712=item B<blendType:> I<string>
713
714Specify background blending type; option B<-blt>.
715
716=item B<blurRadius:> I<number>
717
718Apply gaussian blur with the specified radius to the transparent
719background; option B<-blr>.
720
721=item B<iconFile:> I<file>
722
723Set the application icon pixmap; option B<-icon>.
601 724
602=item B<scrollColor:> I<colour> 725=item B<scrollColor:> I<colour>
603 726
604Use the specified colour for the scrollbar [default #B2B2B2]. 727Use the specified colour for the scrollbar [default #B2B2B2].
605 728
… …
611=item B<borderColor:> I<colour> 734=item B<borderColor:> I<colour>
612 735
613The colour of the border around the text area and between the scrollbar 736The colour of the border around the text area and between the scrollbar
614and the text. 737and the text.
615 738
616=item B<backgroundPixmap:> I<file[;geom]> 739=item B<backgroundPixmap:> I<file[;oplist]>
617 740
618Use the specified XPM file (note the `.xpm' extension is optional) for 741Use the specified image file for the background and also
619the background and also optionally specify its scaling with a geometry 742optionally specify a colon separated list of operations to modify it.
620string B<WxH+X+Y>, in which B<"W" / "H"> specify the 743Supported operations are:
621horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
622centre (percent). A scale of 0 displays the image with tiling. A scale
623of 1 displays the image without any scaling. A scale of 2 to 9
624specifies an integer number of images in that direction. No image will
625be magnified beyond 10 times its original size. The maximum permitted
626scale is 1000. [default 0x0+50+50]
627 744
628=item B<menu:> I<file[;tag]> 745=over 4
629 746
630Read in the specified menu file (note the `.menu' extension is 747=item B<WxH+X+Y>
631optional) and also optionally specify a starting tag to find. See the 748
632reference documentation for details on the syntax for the menuBar. 749sets scale and position. B<"W" / "H"> specify the horizontal/vertical
750scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
751scale of 0 disables scaling. The maximum permitted scale is 1000.
752
753=item B<op=tile>
754
755enables tiling
756
757=item B<op=keep-aspect>
758
759maintain the image aspect ratio when scaling
760
761=item B<op=root-align>
762
763use the position of the terminal window relative to the root window as
764the image offset, simulating a root window background
765
766=back
767
768The default scale and position setting is C<100x100+50+50>.
769Alternatively, a predefined set of templates can be used to achieve
770the most common setups:
771
772=over 4
773
774=item B<style=tiled>
775
776the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778=item B<style=aspect-stretched>
779
780the image is scaled to fill the whole window maintaining the aspect
781ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783=item B<style=stretched>
784
785the image is scaled to fill the whole window. Equivalent to 100x100
786
787=item B<style=centered>
788
789the image is centered with no scaling. Equivalent to 0x0+50+50
790
791=item B<style=root-tiled>
792
793the image is tiled with no scaling and using 'root' positioning.
794Equivalent to 0x0:op=tile:op=root-align
795
796=back
797
798If multiple templates are specified the last one wins. Note that a
799template overrides all the scale, position and operations settings.
800
801If used in conjunction with B<-tr> option, the specified pixmap will be
802blended over the transparent background using alpha-blending.
633 803
634=item B<path:> I<path> 804=item B<path:> I<path>
635 805
636Specify the colon-delimited search path for finding files (XPM and 806Specify the colon-delimited search path for finding background image files.
637menus), in addition to the paths specified by the B<RXVTPATH> and
638B<PATH> environment variables.
639 807
640=item B<font:> I<fontlist> 808=item B<font:> I<fontlist>
641 809
642Select the fonts to be used. This is a comma separated list of font 810Select the fonts to be used. This is a comma separated list of font names
643names that are used in turn when trying to display Unicode characters. 811that are checked in order when trying to find glyphs for characters. The
644The first font defines the cell size for characters; other fonts might 812first font defines the cell size for characters; other fonts might be
645be smaller, but not larger. A reasonable default font list is always 813smaller, but not (in general) larger. A (hopefully) reasonable default
646appended to it; option B<-fn>. 814font list is always appended to it; option B<-fn>.
647 815
648Each font can either be a standard X11 core font (XLFD) name, with 816Each font can either be a standard X11 core font (XLFD) name, with
649optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 817optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
650 818
651In addition, each font can be prefixed with additional hints and 819In addition, each font can be prefixed with additional hints and
… …
653hint currently is C<codeset=codeset-name>, and this is only used for Xft 821hint currently is C<codeset=codeset-name>, and this is only used for Xft
654fonts. 822fonts.
655 823
656For example, this font resource 824For example, this font resource
657 825
658 URxvt*font: 9x15bold,\ 826 URxvt.font: 9x15bold,\
659 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 827 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
660 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 828 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
661 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 829 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
662 xft:Code2000:antialias=false 830 xft:Code2000:antialias=false
663 831
… …
666it is named first) and thus defines the character cell grid to be 9 pixels 834it is named first) and thus defines the character cell grid to be 9 pixels
667wide and 15 pixels high. 835wide and 15 pixels high.
668 836
669The second font is just used to add additional unicode characters not in 837The second font is just used to add additional unicode characters not in
670the base font, likewise the third, which is unfortunately non-bold, but 838the base font, likewise the third, which is unfortunately non-bold, but
671the bold version of the font does contain less characters, so this is a 839the bold version of the font does contain fewer characters, so this is a
672useful supplement. 840useful supplement.
673 841
674The third font is an Xft font with aliasing turned off, and the characters 842The third font is an Xft font with aliasing turned off, and the characters
675are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 843are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
676contains other characters, but we are not interested in them. 844contains other characters, but we are not interested in them.
… …
700text font will being used for the given style. 868text font will being used for the given style.
701 869
702=item B<intensityStyles:> I<boolean> 870=item B<intensityStyles:> I<boolean>
703 871
704When font styles are not enabled, or this option is enabled (B<True>, 872When font styles are not enabled, or this option is enabled (B<True>,
705option B<-is>, the default), bold and italic font styles imply high 873option B<-is>, the default), bold/blink font styles imply high
706intensity foreground/backround colours. Disabling this option (B<False>, 874intensity foreground/background colours. Disabling this option (B<False>,
707option B<+is>) disables this behaviour, the high intensity colours are not 875option B<+is>) disables this behaviour, the high intensity colours are not
708reachable. 876reachable.
709
710=item B<selectstyle:> I<mode>
711
712Set mouse selection style to B<old> which is 2.20, B<oldword> which is
713xterm style with 2.20 old word selection, or anything else which gives
714xterm style selection.
715
716=item B<scrollstyle:> I<mode>
717
718Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
719the author's favourite.
720 877
721=item B<title:> I<string> 878=item B<title:> I<string>
722 879
723Set window title string, the default title is the command-line 880Set window title string, the default title is the command-line
724specified after the B<-e> option, if any, otherwise the application 881specified after the B<-e> option, if any, otherwise the application
… …
733=item B<mapAlert:> I<boolean> 890=item B<mapAlert:> I<boolean>
734 891
735B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 892B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
736de-iconify (map) on receipt of a bell character [default]. 893de-iconify (map) on receipt of a bell character [default].
737 894
895=item B<urgentOnBell:> I<boolean>
896
897B<True>: set the urgency hint for the wm on receipt of a bell character.
898B<False>: do not set the urgency hint [default].
899
900@@RXVT_NAME@@ resets the urgency hint on every focus change.
901
738=item B<visualBell:> I<boolean> 902=item B<visualBell:> I<boolean>
739 903
740B<True>: use visual bell on receipt of a bell character; option B<-vb>. 904B<True>: use visual bell on receipt of a bell character; option B<-vb>.
741B<False>: no visual bell [default]; option B<+vb>. 905B<False>: no visual bell [default]; option B<+vb>.
742 906
… …
760 924
761The string will be interpreted as if typed into the shell as-is. 925The string will be interpreted as if typed into the shell as-is.
762 926
763Example: 927Example:
764 928
765 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 929 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766 930
767This creates a new file in your home directory with the screen contents 931This creates a new file in your home directory with the screen contents
768everytime you hit C<Print>. 932every time you hit C<Print>.
933
934=item B<scrollstyle:> I<mode>
935
936Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
937the author's favourite.
938
939=item B<thickness:> I<number>
940
941Set the scrollbar width in pixels.
769 942
770=item B<scrollBar:> I<boolean> 943=item B<scrollBar:> I<boolean>
771 944
772B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 945B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
773disable the scrollbar; option B<+sb>. 946disable the scrollbar; option B<+sb>.
… …
793B<False>: do not scroll to bottom when tty receives output; option 966B<False>: do not scroll to bottom when tty receives output; option
794B<+si>. 967B<+si>.
795 968
796=item B<scrollWithBuffer:> I<boolean> 969=item B<scrollWithBuffer:> I<boolean>
797 970
798B<True>: scroll with scrollback buffer when tty receives new lines (and 971B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
799B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 972try to show the same lines) and B<scrollTtyOutput> is False; option
800with scrollback buffer when tty recieves new lines; option B<+sw>. 973B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
974new lines; option B<+sw>.
801 975
802=item B<scrollTtyKeypress:> I<boolean> 976=item B<scrollTtyKeypress:> I<boolean>
803 977
804B<True>: scroll to bottom when a non-special key is pressed. Special keys 978B<True>: scroll to bottom when a non-special key is pressed. Special keys
805are those which are intercepted by rxvt-unicode for special handling and 979are those which are intercepted by rxvt-unicode for special handling and
… …
824=item B<borderLess:> I<boolean> 998=item B<borderLess:> I<boolean>
825 999
826Set MWM hints to request a borderless window, i.e. if honoured by the 1000Set MWM hints to request a borderless window, i.e. if honoured by the
827WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 1001WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
828 1002
1003=item B<skipBuiltinGlyphs:> I<boolean>
1004
1005Compile I<frills>: Disable the usage of the built-in block graphics/line
1006drawing characters and just rely on what the specified fonts provide. Use
1007this if you have a good font and want to use its block graphic glyphs;
1008option B<-sbg>.
1009
829=item B<termName:> I<termname> 1010=item B<termName:> I<termname>
830 1011
831Specifies the terminal type name to be set in the B<TERM> environment 1012Specifies the terminal type name to be set in the B<TERM> environment
832variable; option B<-tn>. 1013variable; option B<-tn>.
833 1014
834=item B<linespace:> I<number> 1015=item B<lineSpace:> I<number>
835 1016
836Specifies number of lines (pixel height) to insert between each row of 1017Specifies number of lines (pixel height) to insert between each row of
837the display [default 0]; option B<-lsp>. 1018the display [default 0]; option B<-lsp>.
838 1019
839=item B<meta8:> I<boolean> 1020=item B<meta8:> I<boolean>
… …
853 1034
854=item B<cursorBlink:> I<boolean> 1035=item B<cursorBlink:> I<boolean>
855 1036
856B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1037B<True>: blink the cursor. B<False>: do not blink the cursor [default];
857option B<-bc>. 1038option B<-bc>.
1039
1040=item B<cursorUnderline:> I<boolean>
1041
1042B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1043option B<-uc>.
858 1044
859=item B<pointerBlank:> I<boolean> 1045=item B<pointerBlank:> I<boolean>
860 1046
861B<True>: blank the pointer when a key is pressed or after a set number 1047B<True>: blank the pointer when a key is pressed or after a set number
862of seconds of inactivity. B<False>: the pointer is always visible 1048of seconds of inactivity. B<False>: the pointer is always visible
… …
876large number (e.g. C<987654321>) to effectively disable the timeout. 1062large number (e.g. C<987654321>) to effectively disable the timeout.
877 1063
878=item B<backspacekey:> I<string> 1064=item B<backspacekey:> I<string>
879 1065
880The string to send when the backspace key is pressed. If set to B<DEC> 1066The string to send when the backspace key is pressed. If set to B<DEC>
881or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1067or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
882(code 8) - which can be reversed with the appropriate DEC private mode 1068(code 8) - which can be reversed with the appropriate DEC private mode
883escape sequence. 1069escape sequence.
884 1070
885=item B<deletekey:> I<string> 1071=item B<deletekey:> I<string>
886 1072
… …
888pressed. If unset it will send the sequence traditionally associated 1074pressed. If unset it will send the sequence traditionally associated
889with the B<Execute> key. 1075with the B<Execute> key.
890 1076
891=item B<cutchars:> I<string> 1077=item B<cutchars:> I<string>
892 1078
893The characters used as delimiters for double-click word selection. The 1079The characters used as delimiters for double-click word selection
894built-in default: 1080(whitespace delimiting is added automatically if resource is given).
895 1081
1082When the perl selection extension is in use (the default if compiled
1083in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1084characters will be created (if the resource exists, otherwise, no regex
1085will be created). In this mode, characters outside ISO-8859-1 can be used.
1086
1087When the selection extension is not used, only ISO-8859-1 characters can
1088be used. If not specified, the built-in default is used:
1089
896B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1090B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
897 1091
898=item B<preeditType:> I<style> 1092=item B<preeditType:> I<style>
899 1093
900B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1094B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
901 1095
… …
935default. (Note that many other terminals, including xterm, have these 1129default. (Note that many other terminals, including xterm, have these
936sequences enabled by default, which doesn't make it safer, though). 1130sequences enabled by default, which doesn't make it safer, though).
937 1131
938You can enable them by setting this boolean resource or specifying 1132You can enable them by setting this boolean resource or specifying
939B<-insecure> as an option. At the moment, this enables display-answer, 1133B<-insecure> as an option. At the moment, this enables display-answer,
940locale, findfont, icon label and window title requests as well as dynamic 1134locale, findfont, icon label and window title requests.
941menubar dispatch.
942 1135
943=item B<modifier:> I<modifier> 1136=item B<modifier:> I<modifier>
944 1137
945Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1138Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
946B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1139B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
950 1143
951Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1144Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
952character is passed through. It may contain escape values as described 1145character is passed through. It may contain escape values as described
953in the entry on B<keysym> following. 1146in the entry on B<keysym> following.
954 1147
955=item B<secondaryScreen:> I<bool> 1148=item B<secondaryScreen:> I<boolean>
956 1149
957Turn on/off secondary screen (default enabled). 1150Turn on/off secondary screen (default enabled).
958 1151
959=item B<secondaryScroll:> I<bool> 1152=item B<secondaryScroll:> I<boolean>
960 1153
961Turn on/off secondary screen scroll (default enabled). If the this 1154Turn on/off secondary screen scroll (default enabled). If this
962option is enabled, scrolls on the secondary screen will change the 1155option is enabled, scrolls on the secondary screen will change the
963scrollback buffer and switching to/from the secondary screen will 1156scrollback buffer and, when secondaryScreen is off, switching
964instead scroll the screen up. 1157to/from the secondary screen will instead scroll the screen up.
965 1158
966=item B<hold>: I<bool> 1159=item B<hold>: I<boolean>
967 1160
968Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1161Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969will not immediately destroy its window when the program executed within 1162will not immediately destroy its window when the program executed within
970it exits. Instead, it will wait till it is being killed or closed by the 1163it exits. Instead, it will wait till it is being killed or closed by the
971user. 1164user.
1165
1166=item B<chdir>: I<path>
1167
1168Sets the working directory for the shell (or the command specified via
1169B<-e>). The I<path> must be an absolute path and it must exist for
1170@@RXVT_NAME@@ to start. If it isn't specified then the current working
1171directory will be used; option B<-cd>.
972 1172
973=item B<keysym.>I<sym>: I<string> 1173=item B<keysym.>I<sym>: I<string>
974 1174
975Compile I<frills>: Associate I<string> with keysym I<sym>. The 1175Compile I<frills>: Associate I<string> with keysym I<sym>. The
976intervening resource name B<keysym.> cannot be omitted. 1176intervening resource name B<keysym.> cannot be omitted.
… …
990searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1190searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
991omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1191omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
992keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1192keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
993performed in an exact manner; however, the closest match is assured. 1193performed in an exact manner; however, the closest match is assured.
994 1194
995I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1195I<string> may contain escape values (C<\n>: newline, C<\000>: octal
996C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1196number), see RESOURCES in C<man 7 X> for further details.
997C<\000>: octal number) or verbatim control characters (C<^?>: delete,
998C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
999can start or end with whitespace.
1000 1197
1001Please note that you need to double the C<\> when using
1002C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1003use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1004@@RXVT_NAME@@'s own processing).
1005
1006You can define a range of keysyms in one shot by providing a I<string> 1198You can define a range of keysyms in one shot by
1199loading the C<keysym-list> perl extension and providing a I<string>
1007with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1200with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1008should be a character not used by the strings. 1201should be a character not used by the strings.
1009 1202
1010Its usage can be demonstrated by an example: 1203Its usage can be demonstrated by an example:
1011 1204
1012 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1205 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1013 1206
1014The above line is equivalent to the following three lines: 1207The above line is equivalent to the following three lines:
1015 1208
1016 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1209 URxvt.keysym.Meta-Control-0x61: \033<a>
1017 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1210 URxvt.keysym.Meta-Control-0x62: \033<b>
1018 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1211 URxvt.keysym.Meta-Control-0x63: \033<c>
1019 1212
1020If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1213If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1021is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1214is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1022example the following means "change the current locale to C<zh_CN.GBK> 1215example the following means "change the current locale to C<zh_CN.GBK>
1023when Control-Meta-c is being pressed": 1216when Control-Meta-c is being pressed":
1024 1217
1025 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1218 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1026 1219
1220If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1221is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1222manpage. For example, the F<selection> extension (activated via
1223C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1224
1225 URxvt.keysym.M-C-c: perl:selection:rot13
1226
1027Due the the large number of modifier combinations, a defined key mapping 1227Due the the large number of modifier combinations, a defined key mapping
1028will match if at I<at least> the specified identifiers are being set, and 1228will match if I<at least> the specified identifiers are being set, and
1029no other key mappings with those and more bits are being defined. That 1229no other key mappings with those and more bits are being defined. That
1030means that defining a key map for C<a> will automatically provide 1230means that defining a key map for C<a> will automatically provide
1031definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1231definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1032mappings themselves. 1232mappings themselves.
1033 1233
… …
1054info): 1254info):
1055 1255
1056 URxvt.keysym.M-C-3: command:\033[8;25;80t 1256 URxvt.keysym.M-C-3: command:\033[8;25;80t
1057 URxvt.keysym.M-C-4: command:\033[8;48;110t 1257 URxvt.keysym.M-C-4: command:\033[8;48;110t
1058 1258
1259=item B<perl-ext-common>: I<string>
1260
1059=item B<perl-ext>: I<string> 1261=item B<perl-ext>: I<string>
1060 1262
1061Colon-separated list of perl extension scripts to use in this terminal 1263Comma-separated list(s) of perl extension scripts (default: C<default>) to
1264use in this terminal instance; option B<-pe>.
1265
1266Extension names can be prefixed with a C<-> sign to prohibit using
1267them. This can be useful to selectively disable some extensions loaded
1268by default, or specified via the C<perl-ext-common> resource. For
1269example, C<default,-selection> will use all the default extension except
1270C<selection>.
1271
1272Extension names can also be followed by an argument in angle brackets
1273(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1274searchable scrollback to Alt/Meta-s). Mentioning the same extension
1275multiple times with different arguments will pass multiple arguments to
1276the extension.
1277
1062instance. Each extension is looked up in the library directories, loaded 1278Each extension is looked up in the library directories, loaded if
1063if necessary, and bound to the current terminal instance; option B<-pe>. 1279necessary, and bound to the current terminal instance.
1280
1281If both of these resources are the empty string, then the perl
1282interpreter will not be initialized. The idea behind two options is that
1283B<perl-ext-common> will be used for extensions that should be available to
1284all instances, while B<perl-ext> is used for specific instances.
1064 1285
1065=item B<perl-eval>: I<string> 1286=item B<perl-eval>: I<string>
1066 1287
1067Perl code to be evaluated when all extensions have been registered. See the 1288Perl code to be evaluated when all extensions have been registered. See
1068rxvtperl(3) manpage. 1289the @@RXVT_NAME@@perl(3) manpage.
1069 1290
1070=item B<perl-lib>: I<path> 1291=item B<perl-lib>: I<path>
1071 1292
1072Colon-separated list of additional directories that hold extension 1293Colon-separated list of additional directories that hold extension
1073scripts. When looking for extensions specified by the C<perl> resource, 1294scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1074@@RXVT_NAME@@ will first look in these directories and then in 1295look in these directories, then in $HOME/.urxvt/ext and lastly in
1075F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>. 1296F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1076 1297
1077See the rxvtperl(3) manpage. 1298See the @@RXVT_NAME@@perl(3) manpage.
1299
1300=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1301
1302Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1303details.
1304
1305=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1306
1307Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1308for details.
1309
1310=item B<searchable-scrollback:> I<keysym>
1311
1312Sets the hotkey that starts the incremental scrollback buffer search
1313(default: C<M-s>).
1314
1315=item B<urlLauncher>: I<string>
1316
1317Specifies the program to be started with a URL argument. Used by the
1318C<selection-popup> and C<matcher> perl extensions.
1319
1320=item B<transient-for>: I<windowid>
1321
1322Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1323
1324=item B<override-redirect>: I<boolean>
1325
1326Compile I<frills>: Sets override-redirect for the terminal window, making
1327it almost invisible to window managers; option B<-override-redirect>.
1328
1329=item B<iso14755:> I<boolean>
1330
1331Turn on/off ISO 14755 (default enabled).
1332
1333=item B<iso14755_52:> I<boolean>
1334
1335Turn on/off ISO 14755 5.2 mode (default enabled).
1078 1336
1079=back 1337=back
1080 1338
1081=head1 THE SCROLLBAR 1339=head1 THE SCROLLBAR
1082 1340
… …
1101application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1359application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1102(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1360(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1103up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1361up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1104respectively. 1362respectively.
1105 1363
1106=head1 TEXT SELECTION AND INSERTION 1364=head1 THE SELECTION: SELECTING AND PASTING TEXT
1107 1365
1108The behaviour of text selection and insertion mechanism is similar to 1366The behaviour of text selection and insertion/pasting mechanism is similar
1109I<xterm>(1). 1367to I<xterm>(1).
1110 1368
1111=over 4 1369=over 4
1112 1370
1113=item B<Selection>: 1371=item B<Selecting>:
1114 1372
1115Left click at the beginning of the region, drag to the end of the region 1373Left click at the beginning of the region, drag to the end of the region
1116and release; Right click to extend the marked region; Left double-click 1374and release; Right click to extend the marked region; Left double-click
1117to select a word; Left triple-click to select the entire logical line 1375to select a word; Left triple-click to select the entire logical line
1118(which can span multiple screen lines), unless modified by resource 1376(which can span multiple screen lines), unless modified by resource
… …
1122(Compile: I<frills>) will create a rectangular selection instead of a 1380(Compile: I<frills>) will create a rectangular selection instead of a
1123normal one. In this mode, every selected row becomes its own line in the 1381normal one. In this mode, every selected row becomes its own line in the
1124selection, and trailing whitespace is visually underlined and removed from 1382selection, and trailing whitespace is visually underlined and removed from
1125the selection. 1383the selection.
1126 1384
1127=item B<Insertion>: 1385=item B<Pasting>:
1128 1386
1129Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1387Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1130an B<@@RXVT_NAME@@> window causes the current text selection to be 1388window causes the value of the PRIMARY selection (or CLIPBOARD with the
1131inserted as if it had been typed on the keyboard. 1389B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1390
1391Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1392inserted too.
1132 1393
1133=back 1394=back
1134 1395
1135=head1 CHANGING FONTS 1396=head1 CHANGING FONTS
1136 1397
1137Changing fonts (or font sizes, respectively) via the keypad is not yet 1398Changing fonts (or font sizes, respectively) via the keypad is not yet
1138supported in rxvt-unicode. Bug me if you need this. 1399supported in rxvt-unicode. Bug me if you need this.
1139 1400
1140You can, however, switch fonts at runtime using escape sequences (and 1401You can, however, switch fonts at runtime using escape sequences, e.g.:
1141therefore using the menubar), e.g.:
1142 1402
1143 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1403 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1404
1405You can use keyboard shortcuts, too:
1406
1407 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1408 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1144 1409
1145rxvt-unicode will automatically re-apply these fonts to the output so far. 1410rxvt-unicode will automatically re-apply these fonts to the output so far.
1146 1411
1147=head1 ISO 14755 SUPPORT 1412=head1 ISO 14755 SUPPORT
1148 1413
1149ISO 14755 is a standard for entering and viewing unicode characters 1414ISO 14755 is a standard for entering and viewing unicode characters
1150and character codes using the keyboard. It consists of 4 parts. The 1415and character codes using the keyboard. It consists of 4 parts. The
1151first part is available rxvt-unicode has been compiled with 1416first part is available if rxvt-unicode has been compiled with
1152C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1417C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1153with C<--enable-iso14755>. 1418with C<--enable-iso14755>.
1154 1419
1155=over 4 1420=over 4
1156 1421
… …
1176This mode lets you input characters representing the keycap symbols of 1441This mode lets you input characters representing the keycap symbols of
1177your keyboard, if representable in the current locale encoding. 1442your keyboard, if representable in the current locale encoding.
1178 1443
1179Start by pressing C<Control> and C<Shift> together, then releasing 1444Start by pressing C<Control> and C<Shift> together, then releasing
1180them. The next special key (cursor keys, home etc.) you enter will not 1445them. The next special key (cursor keys, home etc.) you enter will not
1181invoke it's usual function but instead will insert the corresponding 1446invoke its usual function but instead will insert the corresponding
1182keycap symbol. The symbol will only be entered when the key has been 1447keycap symbol. The symbol will only be entered when the key has been
1183released, otherwise pressing e.g. C<Shift> would enter the symbol for 1448released, otherwise pressing e.g. C<Shift> would enter the symbol for
1184C<ISO Level 2 Switch>, although your intention might have been to enter a 1449C<ISO Level 2 Switch>, although your intention might have been to enter a
1185reverse tab (Shift-Tab). 1450reverse tab (Shift-Tab).
1186 1451
… …
1214B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1479B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1215it can be seen via the I<who(1)> command, and can accept messages. To 1480it can be seen via the I<who(1)> command, and can accept messages. To
1216allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1481allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1217on some systems or setgid to root or to some other group on others. 1482on some systems or setgid to root or to some other group on others.
1218 1483
1219=head1 COLORS AND GRAPHICS 1484=head1 COLOURS AND GRAPHICS
1220 1485
1221In addition to the default foreground and background colours, 1486In addition to the default foreground and background colours,
1222B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1487B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1223high-intensity bold/blink versions of the same). Here is a list of the 1488high-intensity (potentially bold/blink) versions of the same, and 72 (or
1224colours with their B<rgb.txt> names. 1489240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1490cube plus a 8 (24) colour greyscale ramp.
1491
1492Here is a list of the ANSI colours with their names.
1225 1493
1226=begin table 1494=begin table
1227 1495
1228 B<color0> (black) = Black 1496 B<color0> (black) = Black
1229 B<color1> (red) = Red3 1497 B<color1> (red) = Red3
… …
1249It is also possible to specify the colour values of B<foreground>, 1517It is also possible to specify the colour values of B<foreground>,
1250B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1518B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1251a number 0-15, as a convenient shorthand to reference the colour name of 1519a number 0-15, as a convenient shorthand to reference the colour name of
1252color0-color15. 1520color0-color15.
1253 1521
1522The following text gives values for the standard 88 colour mode (and
1523values for the 256 colour mode in parentheses).
1524
1525The RGB cube uses indices 16..79 (16..231) using the following formulas:
1526
1527 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1528 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1529
1530The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1531steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1532the RGB cube.
1533
1534Together, all those colours implement the 88 (256) colour xterm
1535colours. Only the first 16 can be changed using resources currently, the
1536rest can only be changed via command sequences ("escape codes").
1537
1538Applications are advised to use terminfo or command sequences to discover
1539number and RGB values of all colours (yes, you can query this...).
1540
1254Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1541Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1255always swapping the foreground/background colours. This is in contrast to 1542always swapping the foreground/background colours. This is in contrast to
1256I<xterm>(1) where the colours are only swapped if they have not otherwise 1543I<xterm>(1) where the colours are only swapped if they have not otherwise
1257been specified. For example, 1544been specified. For example,
1258 1545
1546 @@RXVT_NAME@@ -fg Black -bg White -rv
1547
1548would yield White on Black, while on I<xterm>(1) it would yield Black on
1549White.
1550
1551=head2 ALPHA CHANNEL SUPPORT
1552
1553If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1554their act together, rxvt-unicode will do its own alpha channel management:
1555
1556You can prefix any colour with an opaqueness percentage enclosed in
1557brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1558(0-100) that specifies the opacity of the colour, where C<0> is completely
1559transparent and C<100> is completely opaque. For example, C<[50]red> is a
1560half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1561is the recommended format to specify transparency values, and works with
1562all ways to specify a colour.
1563
1564For complete control, rxvt-unicode also supports
1565C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1566specifications, where the additional C<aaaa> component specifies opacity
1567(alpha) values. The minimum value of C<0000> is completely transparent,
1568while C<ffff> is completely opaque). The two example colours from
1569earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1570C<rgba:0000/ff00/0000/f332>.
1571
1572You probably need to specify B<"-depth 32">, too, to force a visual with
1573alpha channels, and have the luck that your X-server uses ARGB pixel
1574layout, as X is far from just supporting ARGB visuals out of the box, and
1575rxvt-unicode just fudges around.
1576
1577For example, the following selects an almost completely transparent black
1578background, and an almost opaque pink foreground:
1579
1580 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1581
1582When not using a background image, then the interpretation of the
1583alpha channel is up to your compositing manager (most interpret it as
1584transparency of course).
1585
1586When using a background pixmap or pseudo-transparency, then the background
1587colour will always behave as if it were completely transparent (so the
1588background image shows instead), regardless of how it was specified, while
1589other colours will either be transparent as specified (the background
1590image will show through) on servers supporting the RENDER extension, or
1591fully opaque on servers not supporting the RENDER EXTENSION.
1592
1593Please note that due to bugs in Xft, specifying alpha values might result
1594in garbage being displayed when the X-server does not support the RENDER
1595extension.
1596
1597=head1 ENVIRONMENT
1598
1599B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1600
1259=over 4 1601=over 4
1260 1602
1261=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1262
1263would yield White on Black, while on I<xterm>(1) it would yield Black
1264on White.
1265
1266=back
1267
1268=head1 ENVIRONMENT
1269
1270B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1271
1272=over 4
1273
1274=item B<TERM> 1603=item B<TERM>
1275 1604
1276Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1605Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1277resources or on the commandline. 1606resources or on the command line.
1278 1607
1279=item B<COLORTERM> 1608=item B<COLORTERM>
1280 1609
1281Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1610Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1282compiled with XPM support, and optionally with the added extension 1611compiled with background image support, and optionally with the added
1283C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1612extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1613screen.
1284 1614
1285=item B<COLORFGBG> 1615=item B<COLORFGBG>
1286 1616
1287Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1617Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1288the colour code used as default foreground/text colour (or the string 1618the colour code used as default foreground/text colour (or the string
1289C<default> to indicate that the default-colour escape sequence is to be 1619C<default> to indicate that the default-colour escape sequence is to be
1290used), C<bg> is the colour code used as default background colour (or the 1620used), C<bg> is the colour code used as default background colour (or the
1291string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1621string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1292was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1622was compiled with background image support. Libraries like C<ncurses>
1293(and do) use this information to optimize screen output. 1623and C<slang> can (and do) use this information to optimize screen output.
1294 1624
1295=item B<WINDOWID> 1625=item B<WINDOWID>
1296 1626
1297Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1627Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1298window, which usually has subwindows for the scrollbar, the terminal 1628window, which usually has subwindows for the scrollbar, the terminal
… …
1304C<--with-terminfo=PATH>. 1634C<--with-terminfo=PATH>.
1305 1635
1306=item B<DISPLAY> 1636=item B<DISPLAY>
1307 1637
1308Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1638Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1309display in it's child processes. 1639display in its child processes if C<-display> isn't used to override. It
1640defaults to C<:0> if it doesn't exist.
1310 1641
1311=item B<SHELL> 1642=item B<SHELL>
1312 1643
1313The shell to be used for command execution, defaults to C</bin/sh>. 1644The shell to be used for command execution, defaults to C</bin/sh>.
1314
1315=item B<RXVTPATH>
1316
1317The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1318files.
1319
1320=item B<PATH>
1321
1322Used in the same way as C<RXVTPATH>.
1323 1645
1324=item B<RXVT_SOCKET> 1646=item B<RXVT_SOCKET>
1325 1647
1326The unix domain socket path used by @@RXVT_NAME@@c(1) and 1648The unix domain socket path used by @@RXVT_NAME@@c(1) and
1327@@RXVT_NAME@@d(1). 1649@@RXVT_NAME@@d(1).
1328 1650
1329Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1651Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1330 1652
1331=item B<HOME> 1653=item B<HOME>
1332 1654
1333Used to locate the default directory for the unix domain socket for 1655Used to locate the default directory for the unix domain socket for
1334daemon communications and to locate various resource files (such as 1656daemon communications and to locate various resource files (such as
1335C<.Xdefaults>) 1657C<.Xdefaults>)
1336 1658
1337=item B<XAPPLRESDIR> 1659=item B<XAPPLRESDIR>
1338 1660
1339Directory where various X resource files are being located. 1661Directory where application-specific X resource files are located.
1340 1662
1341=item B<XENVIRONMENT> 1663=item B<XENVIRONMENT>
1342 1664
1343If set and accessible, gives the name of a X resource file to be loaded by 1665If set and accessible, gives the name of a X resource file to be loaded by
1344@@RXVT_NAME@@. 1666@@RXVT_NAME@@.
… …
1349 1671
1350=over 4 1672=over 4
1351 1673
1352=item B</usr/lib/X11/rgb.txt> 1674=item B</usr/lib/X11/rgb.txt>
1353 1675
1354Color names. 1676Colour names.
1355 1677
1356=back 1678=back
1357 1679
1358=head1 SEE ALSO 1680=head1 SEE ALSO
1359 1681
… …
1365 1687
1366=item Project Coordinator 1688=item Project Coordinator
1367 1689
1368Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1690Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1369 1691
1370L<http://software.schmorp.de/#rxvt-unicode> 1692L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1371 1693
1372=back 1694=back
1373 1695
1374=head1 AUTHORS 1696=head1 AUTHORS
1375 1697
… …
1397 1719
1398Project Coordinator (changes.txt 2.21a to 2.4.5) 1720Project Coordinator (changes.txt 2.21a to 2.4.5)
1399 1721
1400=item Geoff Wing L<< <gcw@pobox.com> >> 1722=item Geoff Wing L<< <gcw@pobox.com> >>
1401 1723
1402Rewrote screen display and text selection routines. Project Coordinator 1724Rewrote screen display and text selection routines.
1725
1403(changes.txt 2.4.6 - rxvt-unicode) 1726Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1404 1727
1405=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1728=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1406 1729
1407Forked rxvt-unicode, rewrote most of the display code and internal 1730Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1408character handling to store text in unicode, improve xterm 1731extension, random hacks, numerous bugfixes and extensions.
1409compatibility and apply numerous other bugfixes and extensions.
1410 1732
1411Project Coordinator (Changes 1.0 -) 1733Project Coordinator (Changes 1.0 -)
1412 1734
1735=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1736
1737pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1738
1413=back 1739=back
1414 1740

Diff Legend

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