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.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 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 frequently 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 23frequently asked questions and answer to them and some common
24problems. That document is also accessible on the World-Wide-Web at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
21 26
22=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
23 28
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
26world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
27especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
28like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
29like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
30scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
32as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
34such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
35change. 40change.
36 41
37If 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
38me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
39terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
40because 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
41another for japanese. 46another for japanese.
42 47
43Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
44display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
45programs 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
46to choose any font for any script freely. 51to choose any font for any script freely.
47 52
48Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
49it'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
50in 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
51rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
52 57
53It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
54and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
55without 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
56a 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
57from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
58drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
60 65
61It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
62been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
64 69
65=head1 OPTIONS 70=head1 OPTIONS
66 71
67The 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
91 96
92Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (B<-d> still
93respected). In the absence of this option, the display specified by the 98respected). In the absence of this option, the display specified by the
94B<DISPLAY> environment variable is used. 99B<DISPLAY> environment variable is used.
95 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]
110
96=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
97 112
98Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
99 114
100=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
101 116
102Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
103 118
104=item B<-j>|B<+j> 119=item B<-j>|B<+j>
105 120
106Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
107 122
108=item B<-ip>|B<+ip> 123=item B<-ss>|B<+ss>
109 124
110Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
111B<-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@@)!>
112 136
113=item B<-fade> I<number> 137=item B<-fade> I<number>
114 138
115Fade the text by the given percentage when focus is lost. 139Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade
141colour; resource B<fading>.
142
143=item B<-fadecolor> I<colour>
144
145Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>.
116 147
117=item B<-tint> I<colour> 148=item B<-tint> I<colour>
118 149
119Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 151transparency is enabled with B<-tr>. This only works for
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
121option that can be used to brighten or darken the image in addition to 153used to brighten or darken the image in addition to tinting it.
122tinting 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 colors essentially mean no tinting; resource
158I<tintColor>. Example:
123 159
124=item B<-sh> 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 161
162=item B<-sh> I<number>
163
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
128specified, too). 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> - color 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>;
185resource I<blurRadius>.
129 186
130=item B<-bg> I<colour> 187=item B<-bg> I<colour>
131 188
132Window background colour; resource B<background>. 189Window background colour; resource B<background>.
133 190
134=item B<-fg> I<colour> 191=item B<-fg> I<colour>
135 192
136Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
137 194
138=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
139 196
140Compile I<XPM>: Specify XPM file for the background and also optionally 197Compile I<afterimage>: Specify image file for the background and also
141specify its scaling with a geometry string. Note you may need to add 198optionally specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 199add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
144 201
145=item B<-cr> I<colour> 202=item B<-cr> I<colour>
146 203
147The cursor colour; resource B<cursorColor>. 204The cursor colour; resource B<cursorColor>.
148 205
160resource B<borderColor>. 217resource B<borderColor>.
161 218
162=item B<-fn> I<fontlist> 219=item B<-fn> I<fontlist>
163 220
164Select the fonts to be used. This is a comma separated list of font names 221Select the fonts to be used. This is a comma separated list of font names
165that are used in turn when trying to display Unicode characters. The 222that are checked in order when trying to find glyphs for characters. The
166first font defines the cell size for characters; other fonts might be 223first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A reasonable default font list is 224smaller, but not (in general) larger. A (hopefully) reasonable default
168always appended to it. See resource B<font> for details. 225font list is always appended to it. See resource B<font> for more details.
226
227In short, to specify an X11 core font, just specify its name or prefix it
228with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
229e.g.:
230
231 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
232 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169 233
170See also the question "How does rxvt-unicode choose fonts?" in the FAQ 234See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171section of @@RXVT_NAME@@(7). 235section of @@RXVT_NAME@@(7).
172 236
173=item B<-fb> I<fontlist> 237=item B<-fb> I<fontlist>
174 238
175Compile font-styles: The bold font list to use when bold characters are to 239Compile I<font-styles>: The bold font list to use when B<bold> characters
176be printed. See resource B<boldFont> for details. 240are to be printed. See resource B<boldFont> for details.
177 241
178=item B<-fi> I<fontlist> 242=item B<-fi> I<fontlist>
179 243
180Compile font-styles: The italic font list to use when bold characters are to 244Compile I<font-styles>: The italic font list to use when I<italic>
181be printed. See resource B<italicFont> for details. 245characters are to be printed. See resource B<italicFont> for details.
182 246
183=item B<-fbi> I<fontlist> 247=item B<-fbi> I<fontlist>
184 248
185Compile font-styles: The bold italic font list to use when bold characters are to 249Compile I<font-styles>: The bold italic font list to use when B<< I<bold
186be printed. See resource B<boldItalicFont> for details. 250italic> >> characters are to be printed. See resource B<boldItalicFont>
251for details.
252
253=item B<-is>|B<+is>
254
255Compile I<font-styles>: Bold/Blink font styles imply high intensity
256foreground/background (default). See resource B<intensityStyles> for
257details.
187 258
188=item B<-name> I<name> 259=item B<-name> I<name>
189 260
190Specify the application name under which resources are to be obtained, 261Specify the application name under which resources are to be obtained,
191rather than the default executable file name. Name should not contain 262rather than the default executable file name. Name should not contain
207 278
208=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
209 280
210Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
211 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
212=item B<-si>|B<+si> 292=item B<-si>|B<+si>
213 293
214Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
215B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
216 296
223 303
224Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
225This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
226B<scrollWithBuffer>. 306B<scrollWithBuffer>.
227 307
228=item B<-sr>|B<+sr>
229
230Put scrollbar on right/left; resource B<scrollBar_right>.
231
232=item B<-st>|B<+st> 308=item B<-ptab>|B<+ptab>
233 309
234Display normal (non XTerm/NeXT) scrollbar without/with a trough; 310If enabled (default), "Horizontal Tab" characters are being stored as
235resource B<scrollBar_floating>. 311actual wide characters in the screen buffer, which makes it possible to
312select and paste them. Since a horizontal tab is a cursor movement and
313not an actual glyph, this can sometimes be visually annoying as the cursor
314on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236 315
237=item B<-bc>|B<+bc> 316=item B<-bc>|B<+bc>
238 317
239Blink the cursor; resource B<cursorBlink>. 318Blink the cursor; resource B<cursorBlink>.
240 319
263 342
264Compile I<frills>: Set MWM hints to request a borderless window, i.e. 343Compile I<frills>: Set MWM hints to request a borderless window, i.e.
265if honoured by the WM, the rxvt-unicode window will not have window 344if honoured by the WM, the rxvt-unicode window will not have window
266decorations; resource B<borderLess>. 345decorations; resource B<borderLess>.
267 346
347=item B<-override-redirect>
348
349Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>.
351
352=item B<-sbg>
353
354Compile I<frills>: Disable the usage of the built-in block graphics/line
355drawing characters and just rely on what the specified fonts provide. Use
356this if you have a good font and want to use its block graphic glyphs;
357resource B<skipBuiltinGlyphs>.
358
268=item B<-lsp> I<number> 359=item B<-lsp> I<number>
269 360
270Compile I<linespace>: Lines (pixel height) to insert between each row 361Compile I<frills>: Lines (pixel height) to insert between each row of
271of the display; resource B<linespace>. 362the display. Useful to work around font rendering problems; resource
363B<lineSpace>.
272 364
273=item B<-tn> I<termname> 365=item B<-tn> I<termname>
274 366
275This option specifies the name of the terminal type to be set in the 367This option specifies the name of the terminal type to be set in the
276B<TERM> environment variable. This terminal type must exist in the 368B<TERM> environment variable. This terminal type must exist in the
285given on the command line. If this option is used, it must be the last 377given on the command line. If this option is used, it must be the last
286on the command-line. If there is no B<-e> option then the default is to 378on the command-line. If there is no B<-e> option then the default is to
287run the program specified by the B<SHELL> environment variable or, 379run the program specified by the B<SHELL> environment variable or,
288failing that, I<sh(1)>. 380failing that, I<sh(1)>.
289 381
382Please note that you must specify a program with arguments. If you want to
383run shell commands, you have to specify the shell, like this:
384
385 @@RXVT_NAME@@ -e sh -c "shell commands"
386
290=item B<-title> I<text> 387=item B<-title> I<text>
291 388
292Window title (B<-T> still respected); the default title is the basename 389Window title (B<-T> still respected); the default title is the basename
293of the program specified after the B<-e> option, if any, otherwise the 390of the program specified after the B<-e> option, if any, otherwise the
294application name; resource B<title>. 391application name; resource B<title>.
312 409
313Compile I<XIM>: input method name. resource B<inputMethod>. 410Compile I<XIM>: input method name. resource B<inputMethod>.
314 411
315=item B<-imlocale> I<string> 412=item B<-imlocale> I<string>
316 413
317The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 414The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
318de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 415C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
319extension to be able to input japanese characters while staying in 416input extension to be able to input japanese characters while staying in
320another locale. 417another locale. resource B<imLocale>.
418
419=item B<-imfont> I<fontset>
420
421Set the font set to use for the X Input Method, see resource B<imFont>
422for more info.
423
424=item B<-tcw>
425
426Change the meaning of triple-click selection with the left mouse
427button. Only effective when the original (non-perl) selection code is
428in-use. Instead of selecting a full line it will extend the selection to
429the end of the logical line only. resource B<tripleclickwords>.
321 430
322=item B<-insecure> 431=item B<-insecure>
323 432
324Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
325sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
339=item B<-ssr>|B<+ssr> 448=item B<-ssr>|B<+ssr>
340 449
341Turn on/off secondary screen scroll (default enabled); resource 450Turn on/off secondary screen scroll (default enabled); resource
342B<secondaryScroll>. 451B<secondaryScroll>.
343 452
453=item B<-hold>|B<+hold>
454
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within
457it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>.
459
344=item B<-xrm> I<resourcestring> 460=item B<-xrm> I<string>
345 461
346No effect on rxvt-unicode. Simply passes through an argument to be made 462Works like the X Toolkit option of the same name, by adding the I<string>
347available in the instance's argument list. Appears in I<WM_COMMAND> in 463as if it were specified in a resource file. Resource values specified this
348some window managers. 464way take precedence over all other resource specifications.
465
466Note that you need to use the I<same> syntax as in the .Xdefaults file,
467e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
468options can be specified as long-options on the commandline, so use
469of B<-xrm> is mostly limited to cases where you want to specify other
470resources (e.g. for input methods) or for compatibility with other
471programs.
472
473=item B<-keysym.>I<sym> I<string>
474
475Remap a key symbol. See resource B<keysym>.
476
477=item B<-embed> I<windowid>
478
479Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
480which enables applications to easily embed a terminal.
481
482Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
483shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
484quite a bit, so don't expect it to keep some specific state. It's best to
485create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
486
487The window will not be destroyed when @@RXVT_NAME@@ exits.
488
489It might be useful to know that @@RXVT_NAME@@ will not close file
490descriptors passed to it (except for stdin/out/err, of course), so you
491can use file descriptors to communicate with the programs within the
492terminal. This works regardless of whether the C<-embed> option was used or
493not.
494
495Here is a short Gtk2-perl snippet that illustrates how this option can be
496used (a longer example is in F<doc/embed>):
497
498 my $rxvt = new Gtk2::Socket;
499 $rxvt->signal_connect_after (realize => sub {
500 my $xid = $_[0]->window->get_xid;
501 system "@@RXVT_NAME@@ -embed $xid &";
502 });
503
504=item B<-pty-fd> I<file descriptor>
505
506Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
507pair but instead use the given file descriptor as the tty master. This is
508useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
509without having to run a program within it.
510
511If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
512entries and will not tinker with pty/tty permissions - you have to do that
513yourself if you want that.
514
515As an extremely special case, specifying C<-1> will completely suppress
516pty/tty operations, which is probably only useful in conjunction with some
517perl extension that manages the terminal.
518
519Here is a example in perl that illustrates how this option can be used (a
520longer example is in F<doc/pty-fd>):
521
522 use IO::Pty;
523 use Fcntl;
524
525 my $pty = new IO::Pty;
526 fcntl $pty, F_SETFD, 0; # clear close-on-exec
527 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
528 close $pty;
529
530 # now communicate with rxvt
531 my $slave = $pty->slave;
532 while (<$slave>) { print $slave "got <$_>\n" }
533
534=item B<-pe> I<string>
535
536Comma-separated list of perl extension scripts to use (or not to use) in
537this terminal instance. See resource B<perl-ext> for details.
349 538
350=back 539=back
351 540
352=head1 RESOURCES (available also as long-options) 541=head1 RESOURCES
353 542
354Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 543Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355options) compiled into your version. 544options) compiled into your version. All resources are also available as
545long-options.
356 546
357There are two different methods that @@RXVT_NAME@@ can use to get the 547You can set and change the resources using X11 tools like B<xrdb>. Many
358Xresource data: using the X libraries (Xrm*-functions) or internal 548distribution do also load settings from the B<~/.Xresources> file when X
359Xresources reader (B<~/.Xdefaults>). For the first method (ie. 549starts. @@RXVT_NAME@@ will consult the following files/resources in order,
360B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 550with later settings overwriting earlier ones:
361resources using X11 tools like B<xset>. Many distribution do also load
362settings from the B<~/.Xresources> file when X starts.
363 551
364If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 552 1. system-wide app-defaults file, either locale-dependent OR global
365lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 553 2. app-defaults file in $XAPPLRESDIR
366set in XAPPLOADDIR/URxvt (compile-time defined: usually 554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
367B</usr/lib/X11/app-defaults/URxvt>) and resources set in 555 4. SCREEN_RESOURCES for the current screen
368B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline
558
369Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
370class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
371resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 561common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
372easily configured, while the class name B<URxvt> allows resources 562configured, while the class name B<URxvt> allows resources unique to
373unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 563B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
374shared between different B<@@RXVT_NAME@@> configurations. If no 564configurations. If no resources are specified, suitable defaults will
375resources are specified, suitable defaults will be used. Command-line 565be used. Command-line arguments can be used to override resource
376arguments can be used to override resource settings. The following 566settings. The following resources are supported (you might want to
377resources are allowed: 567check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
568extensions not documented here):
378 569
379=over 4 570=over 4
571
572=item B<depth:> I<bitdepth>
573
574Compile I<xft>: Attempt to find a visual with the given bit depth;
575option B<-depth>.
576
577=item B<buffered:> I<boolean>
578
579Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
580On some card/driver combination enabling it slightly decreases
581performance, on most it greatly helps it. The slowdown is small, so it
582should normally be enabled.
380 583
381=item B<geometry:> I<geom> 584=item B<geometry:> I<geom>
382 585
383Create the window with the specified X window geometry [default 80x24]; 586Create the window with the specified X window geometry [default 80x24];
384option B<-geometry>. 587option B<-geometry>.
412 615
413=item B<colorIT:> I<colour> 616=item B<colorIT:> I<colour>
414 617
415Use the specified colour to display bold or italic characters when the 618Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 619foreground colour is the default. If font styles are not available
417(Compile styles) and this option is unset, reverse video is used instead. 620(Compile I<styles>) and this option is unset, reverse video is used instead.
418 621
419=item B<colorUL:> I<colour> 622=item B<colorUL:> I<colour>
420 623
421Use the specified colour to display underlined characters when the 624Use the specified colour to display underlined characters when the
422foreground colour is the default. 625foreground colour is the default.
423 626
424=item B<colorRV:> I<colour> 627=item B<colorRV:> I<colour>
425 628
426Use the specified colour as the background for reverse video 629Use the specified colour as the background for reverse video characters
427characters. 630when OPTION_HC is disabled (--disable-frills).
631
632=item B<underlineColor:> I<colour>
633
634If set, use the specified colour as the colour for the underline
635itself. If unset, use the foreground colour.
428 636
429=item B<cursorColor:> I<colour> 637=item B<cursorColor:> I<colour>
430 638
431Use the specified colour for the cursor. The default is to use the 639Use the specified colour for the cursor. The default is to use the
432foreground colour; option B<-cr>. 640foreground colour; option B<-cr>.
443option B<-rv>. B<False>: regular screen colours [default]; option 651option B<-rv>. B<False>: regular screen colours [default]; option
444B<+rv>. See note in B<COLORS AND GRAPHICS> section. 652B<+rv>. See note in B<COLORS AND GRAPHICS> section.
445 653
446=item B<jumpScroll:> I<boolean> 654=item B<jumpScroll:> I<boolean>
447 655
448B<True>: specify that jump scrolling should be used. When scrolling 656B<True>: specify that jump scrolling should be used. When receiving lots
449quickly, fewer screen updates are performed [default]; option B<-j>. 657of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
658has been read, resulting in fewer updates while still displaying every
659received line; option B<-j>.
660
450B<False>: specify that smooth scrolling should be used; option B<+j>. 661B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
662force a screen refresh on each new line it received; option B<+j>.
451 663
452=item B<inheritPixmap:> I<boolean> 664=item B<skipScroll:> I<boolean>
453 665
454B<True>: make the background inherit the parent windows' pixmap, giving 666B<True>: (the default) specify that skip scrolling should be used. When
455artificial transparency. B<False>: do not inherit the parent windows' 667receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
456pixmap. 668(around 60 times per second), resulting in far fewer updates. This can
669result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
670option B<-ss>.
671
672B<False>: specify that everything is to be displayed, even
673if the refresh is too fast for the human eye to read anything (or the
674monitor to display anything); option B<+ss>.
675
676=item B<transparent:> I<boolean>
677
678Turn on/off illusion of a transparent window background.
679
680B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
681future versions.
682
683I<Please address all transparency related issues to Sasha Vasko at
684sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
457 685
458=item B<fading:> I<number> 686=item B<fading:> I<number>
459 687
460Fade the text by the given percentage when focus is lost. 688Fade the text by the given percentage when focus is lost; option B<-fade>.
689
690=item B<fadeColor:> I<colour>
691
692Fade to this colour, when fading is used (see B<fading:>). The default
693colour is black; option B<-fadecolor>.
461 694
462=item B<tintColor:> I<colour> 695=item B<tintColor:> I<colour>
463 696
464Tint the transparent background pixmap with the given colour. 697Tint the transparent background pixmap with the given colour; option
698B<-tint>.
465 699
466=item B<shading:> I<number> 700=item B<shading:> I<number>
467 701
468Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 702Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
469image in addition to tinting it. 703in addition to tinting it; option B<-sh>.
704
705=item B<blendType:> I<string>
706
707Specify background blending type; option B<-blt>.
708
709=item B<blurRadius:> I<number>
710
711Apply Gaussian Blurr with the specified radius to the transparent
712background image; option B<-blr>.
470 713
471=item B<scrollColor:> I<colour> 714=item B<scrollColor:> I<colour>
472 715
473Use the specified colour for the scrollbar [default #B2B2B2]. 716Use the specified colour for the scrollbar [default #B2B2B2].
474 717
475=item B<troughColor:> I<colour> 718=item B<troughColor:> I<colour>
476 719
477Use the specified colour for the scrollbar's trough area [default 720Use the specified colour for the scrollbar's trough area [default
478#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 721#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479 722
480=item B<borderColor:> I<colour> 723=item B<borderColor:> I<colour>
481 724
482The colour of the border around the text area and between the scrollbar 725The colour of the border around the text area and between the scrollbar
483and the text. 726and the text.
484 727
485=item B<backgroundPixmap:> I<file[;geom]> 728=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
486 729
487Use the specified XPM file (note the `.xpm' extension is optional) for 730Use the specified image file for the background and also
488the background and also optionally specify its scaling with a geometry 731optionally specify its scaling with a geometry string B<WxH+X+Y>,
489string B<WxH+X+Y>, in which B<"W" / "H"> specify the 732(default C<0x0+50+50>) in which B<"W" / "H"> specify the
490horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 733horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
491centre (percent). A scale of 0 displays the image with tiling. A scale 734centre (percent). A scale of 0 displays the image with tiling. A scale
492of 1 displays the image without any scaling. A scale of 2 to 9 735of 1 displays the image without any scaling. A scale of 2 to 9 specifies
493specifies an integer number of images in that direction. No image will 736an integer number of images in that direction. No image will be magnified
494be magnified beyond 10 times its original size. The maximum permitted 737beyond 10 times its original size. The maximum permitted scale is 1000.
495scale is 1000. [default 0x0+50+50] 738Additional operations can be specified after colon B<:op1:op2...>.
739Supported operations are:
496 740
497=item B<menu:> I<file[;tag]> 741 tile force background image to be tiled and not scaled. Equivalent to 0x0
742 propscale will scale image keeping proportions
743 auto will scale image to match window size. Equivalent to 100x100
744 hscale will scale image horizontally to the window size
745 vscale will scale image vertically to the window size
746 scale will scale image to match window size
747 root will tile image as if it was a root window background, auto-adjusting
748 whenever terminal window moves
498 749
499Read in the specified menu file (note the `.menu' extension is 750If used in conjunction with B<-tr> option, the specified pixmap will be
500optional) and also optionally specify a starting tag to find. See the 751blended over transparency image using either alpha-blending, or any
501reference documentation for details on the syntax for the menuBar. 752other blending type, specified with B<-blt "type"> option.
502 753
503=item B<path:> I<path> 754=item B<path:> I<path>
504 755
505Specify the colon-delimited search path for finding files (XPM and 756Specify the colon-delimited search path for finding background image files.
506menus), in addition to the paths specified by the B<RXVTPATH> and
507B<PATH> environment variables.
508 757
509=item B<font:> I<fontlist> 758=item B<font:> I<fontlist>
510 759
511Select the fonts to be used. This is a comma separated list of font 760Select the fonts to be used. This is a comma separated list of font names
512names that are used in turn when trying to display Unicode characters. 761that are checked in order when trying to find glyphs for characters. The
513The first font defines the cell size for characters; other fonts might 762first font defines the cell size for characters; other fonts might be
514be smaller, but not larger. A reasonable default font list is always 763smaller, but not (in general) larger. A (hopefully) reasonable default
515appended to it. option B<-fn>. 764font list is always appended to it; option B<-fn>.
516 765
517Each font can either be a standard X11 core font (XLFD) name, with 766Each font can either be a standard X11 core font (XLFD) name, with
518optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 767optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519 768
520In addition, each font can be prefixed with additional hints and 769In addition, each font can be prefixed with additional hints and
521specifications enclosed in square brackets (C<[]>). The only available 770specifications enclosed in square brackets (C<[]>). The only available
522hint currently is C<codeset=codeset-name>, and this is only used for Xft 771hint currently is C<codeset=codeset-name>, and this is only used for Xft
523fonts. 772fonts.
524 773
525For example, this font resource 774For example, this font resource
526 775
527 URxvt*font: 9x15bold,\ 776 URxvt.font: 9x15bold,\
528 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 777 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
529 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 778 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 779 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531 xft:Code2000:antialias=false 780 xft:Code2000:antialias=false
532 781
533specifies five fonts to be used. The first one is C<9x15bold> (actually 782specifies five fonts to be used. The first one is C<9x15bold> (actually
534the iso8859-1 version of the second font), which is the base font (because 783the iso8859-1 version of the second font), which is the base font (because
535it is named first) and thus defines the character cell grid to be 9 pixels 784it is named first) and thus defines the character cell grid to be 9 pixels
536wide and 15 pixels high. 785wide and 15 pixels high.
537 786
538the second font is just used to add additional unicode characters not in 787The second font is just used to add additional unicode characters not in
539the base font, likewise the third, which is unfortunately non-bold, but 788the base font, likewise the third, which is unfortunately non-bold, but
540the bold version of the font does contain less characters, so this is a 789the bold version of the font does contain less characters, so this is a
541useful supplement. 790useful supplement.
542 791
543The third font is an Xft font with aliasing turned off, and the characters 792The third font is an Xft font with aliasing turned off, and the characters
566not possible, replacement fonts of the desired shape will be tried. 815not possible, replacement fonts of the desired shape will be tried.
567 816
568If set, but empty, then this specific style is disabled and the normal 817If set, but empty, then this specific style is disabled and the normal
569text font will being used for the given style. 818text font will being used for the given style.
570 819
571=item B<selectstyle:> I<mode> 820=item B<intensityStyles:> I<boolean>
572 821
573Set mouse selection style to B<old> which is 2.20, B<oldword> which is 822When font styles are not enabled, or this option is enabled (B<True>,
574xterm style with 2.20 old word selection, or anything else which gives 823option B<-is>, the default), bold/blink font styles imply high
575xterm style selection. 824intensity foreground/background colours. Disabling this option (B<False>,
576 825option B<+is>) disables this behaviour, the high intensity colours are not
577=item B<scrollstyle:> I<mode> 826reachable.
578
579Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580the author's favourite..
581 827
582=item B<title:> I<string> 828=item B<title:> I<string>
583 829
584Set window title string, the default title is the command-line 830Set window title string, the default title is the command-line
585specified after the B<-e> option, if any, otherwise the application 831specified after the B<-e> option, if any, otherwise the application
594=item B<mapAlert:> I<boolean> 840=item B<mapAlert:> I<boolean>
595 841
596B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 842B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
597de-iconify (map) on receipt of a bell character [default]. 843de-iconify (map) on receipt of a bell character [default].
598 844
845=item B<urgentOnBell:> I<boolean>
846
847B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default].
849
599=item B<visualBell:> I<boolean> 850=item B<visualBell:> I<boolean>
600 851
601B<True>: use visual bell on receipt of a bell character; option B<-vb>. 852B<True>: use visual bell on receipt of a bell character; option B<-vb>.
602B<False>: no visual bell [default]; option B<+vb>. 853B<False>: no visual bell [default]; option B<+vb>.
603 854
617 868
618Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 869Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 870B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620B<Shift-Print> to include the scrollback as well. 871B<Shift-Print> to include the scrollback as well.
621 872
873The string will be interpreted as if typed into the shell as-is.
874
875Example:
876
877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878
879This creates a new file in your home directory with the screen contents
880every time you hit C<Print>.
881
882=item B<scrollstyle:> I<mode>
883
884Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885the author's favourite.
886
622=item B<scrollBar:> I<boolean> 887=item B<scrollBar:> I<boolean>
623 888
624B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625disable the scrollbar; option B<+sb>. 890disable the scrollbar; option B<+sb>.
626 891
646B<+si>. 911B<+si>.
647 912
648=item B<scrollWithBuffer:> I<boolean> 913=item B<scrollWithBuffer:> I<boolean>
649 914
650B<True>: scroll with scrollback buffer when tty receives new lines (and 915B<True>: scroll with scrollback buffer when tty receives new lines (and
651B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 916B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652with scrollback buffer when tty recieves new lines; option B<-sw>. 917with scrollback buffer when tty receives new lines; option B<+sw>.
653 918
654=item B<scrollTtyKeypress:> I<boolean> 919=item B<scrollTtyKeypress:> I<boolean>
655 920
656B<True>: scroll to bottom when a non-special key is pressed. Special keys 921B<True>: scroll to bottom when a non-special key is pressed. Special keys
657are those which are intercepted by rxvt-unicode for special handling and 922are those which are intercepted by rxvt-unicode for special handling and
676=item B<borderLess:> I<boolean> 941=item B<borderLess:> I<boolean>
677 942
678Set MWM hints to request a borderless window, i.e. if honoured by the 943Set MWM hints to request a borderless window, i.e. if honoured by the
679WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 944WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
680 945
946=item B<skipBuiltinGlyphs:> I<boolean>
947
948Compile I<frills>: Disable the usage of the built-in block graphics/line
949drawing characters and just rely on what the specified fonts provide. Use
950this if you have a good font and want to use its block graphic glyphs;
951option B<-sbg>.
952
681=item B<termName:> I<termname> 953=item B<termName:> I<termname>
682 954
683Specifies the terminal type name to be set in the B<TERM> environment 955Specifies the terminal type name to be set in the B<TERM> environment
684variable; option B<-tn>. 956variable; option B<-tn>.
685 957
686=item B<linespace:> I<number> 958=item B<lineSpace:> I<number>
687 959
688Specifies number of lines (pixel height) to insert between each row of 960Specifies number of lines (pixel height) to insert between each row of
689the display [default 0]; option B<-lsp>. 961the display [default 0]; option B<-lsp>.
690 962
691=item B<meta8:> I<boolean> 963=item B<meta8:> I<boolean>
695 967
696=item B<mouseWheelScrollPage:> I<boolean> 968=item B<mouseWheelScrollPage:> I<boolean>
697 969
698B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 970B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699scrolls five lines [default]. 971scrolls five lines [default].
972
973=item B<pastableTabs:> I<boolean>
974
975B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
976movement only; option C<-ptab>.
700 977
701=item B<cursorBlink:> I<boolean> 978=item B<cursorBlink:> I<boolean>
702 979
703B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 980B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704option B<-bc>. 981option B<-bc>.
717 994
718Mouse pointer background colour. 995Mouse pointer background colour.
719 996
720=item B<pointerBlankDelay:> I<number> 997=item B<pointerBlankDelay:> I<number>
721 998
722Specifies number of seconds before blanking the pointer [default 2]. 999Specifies number of seconds before blanking the pointer [default 2]. Use a
1000large number (e.g. C<987654321>) to effectively disable the timeout.
723 1001
724=item B<backspacekey:> I<string> 1002=item B<backspacekey:> I<string>
725 1003
726The string to send when the backspace key is pressed. If set to B<DEC> 1004The string to send when the backspace key is pressed. If set to B<DEC>
727or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1005or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
734pressed. If unset it will send the sequence traditionally associated 1012pressed. If unset it will send the sequence traditionally associated
735with the B<Execute> key. 1013with the B<Execute> key.
736 1014
737=item B<cutchars:> I<string> 1015=item B<cutchars:> I<string>
738 1016
739The characters used as delimiters for double-click word selection. The 1017The characters used as delimiters for double-click word selection
740built-in default: 1018(whitespace delimiting is added automatically if resource is given).
741 1019
1020When the perl selection extension is in use (the default if compiled
1021in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1022characters will be created (if the resource exists, otherwise, no regex
1023will be created). In this mode, characters outside ISO-8859-1 can be used.
1024
1025When the selection extension is not used, only ISO-8859-1 characters can
1026be used. If not specified, the built-in default is used:
1027
742B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1028B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
743 1029
744=item B<preeditType:> I<style> 1030=item B<preeditType:> I<style>
745 1031
746B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1032B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
747 1033
749 1035
750I<name> of inputMethod to use; option B<-im>. 1036I<name> of inputMethod to use; option B<-im>.
751 1037
752=item B<imLocale:> I<name> 1038=item B<imLocale:> I<name>
753 1039
754The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1040The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 1041C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756extension to be able to input japanese characters while staying in 1042input extension to be able to input japanese characters while staying in
757another locale. option B<-imlocale>. 1043another locale; option B<-imlocale>.
1044
1045=item B<imFont:> I<fontset>
1046
1047Specify the font-set used for XIM styles C<OverTheSpot> or
1048C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
1049by commas), i.e. it's not in the same format as the other font lists used
1050in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1051found, preferably one or two pixels differing in size to the base font.
1052option B<-imfont>.
1053
1054=item B<tripleclickwords:> I<boolean>
1055
1056Change the meaning of triple-click selection with the left mouse
1057button. Instead of selecting a full line it will extend the selection to
1058the end of the logical line only; option B<-tcw>.
758 1059
759=item B<insecure:> I<boolean> 1060=item B<insecure:> I<boolean>
760 1061
761Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1062Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762echo arbitrary strings like the icon name or the locale. This could be 1063echo arbitrary strings like the icon name or the locale. This could be
763abused if somebody gets 8-bit-clean access to your display, whether 1064abused if somebody gets 8-bit-clean access to your display, whether
764throuh a mail client displaying mail bodies unfiltered or though 1065through a mail client displaying mail bodies unfiltered or through
765write(1). Therefore, these sequences are disabled by default. (Note 1066write(1) or any other means. Therefore, these sequences are disabled by
766that other terminals, including xterm, have these sequences 1067default. (Note that many other terminals, including xterm, have these
767enabled by default). You can enable them by setting this boolean 1068sequences enabled by default, which doesn't make it safer, though).
768resource or specifying B<-insecure> as an option. At the moment, this 1069
769enabled display-answer, locale, findfont, icon label and window title 1070You can enable them by setting this boolean resource or specifying
770requests as well as dynamic menubar dispatch. 1071B<-insecure> as an option. At the moment, this enables display-answer,
1072locale, findfont, icon label and window title requests.
771 1073
772=item B<modifier:> I<modifier> 1074=item B<modifier:> I<modifier>
773 1075
774Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1076Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1077B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
779 1081
780Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1082Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
781character is passed through. It may contain escape values as described 1083character is passed through. It may contain escape values as described
782in the entry on B<keysym> following. 1084in the entry on B<keysym> following.
783 1085
784=item B<secondaryScreen:> I<bool> 1086=item B<secondaryScreen:> I<boolean>
785 1087
786Turn on/off secondary screen (default enabled). 1088Turn on/off secondary screen (default enabled).
787 1089
788=item B<secondaryScroll:> I<bool> 1090=item B<secondaryScroll:> I<boolean>
789 1091
790Turn on/off secondary screen scroll (default enabled). If the this 1092Turn on/off secondary screen scroll (default enabled). If this
791option is enabled, scrolls on the secondary screen will change the 1093option is enabled, scrolls on the secondary screen will change the
792scrollback buffer and switching to/from the secondary screen will 1094scrollback buffer and switching to/from the secondary screen will
793instead scroll the screen up. 1095instead scroll the screen up.
794 1096
1097=item B<hold>: I<boolean>
1098
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within
1101it exits. Instead, it will wait till it is being killed or closed by the
1102user.
1103
795=item B<keysym.>I<sym>: I<string> 1104=item B<keysym.>I<sym>: I<string>
796 1105
797Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1106Compile I<frills>: Associate I<string> with keysym I<sym>. The
798contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
799newline, \r: return, \t:
800tab, \000: octal number) or control characters (^?: delete, ^@: null,
801^A ...) and may enclosed with double quotes so that it can start or end
802with whitespace. The intervening resource name B<keysym.> cannot be 1107intervening resource name B<keysym.> cannot be omitted.
803omitted. This resource is only available when compiled with 1108
804KEYSYM_RESOURCE. 1109The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
1110any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
1111B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
1112and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
1113B<2>, B<3>, B<4>, B<5>.
1114
1115The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1116whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1117keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1118current application keymap mode state.
1119
1120The spellings of I<key> can be obtained by using B<xev>(1) command or
1121searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1122omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1123keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1124performed in an exact manner; however, the closest match is assured.
1125
1126I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1127number), see RESOURCES in C<man 7 X> for futher details.
1128
1129You can define a range of keysyms in one shot by providing a I<string>
1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1131should be a character not used by the strings.
1132
1133Its usage can be demonstrated by an example:
1134
1135 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1136
1137The above line is equivalent to the following three lines:
1138
1139 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1140 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1141 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1142
1143If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1144is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1145example the following means "change the current locale to C<zh_CN.GBK>
1146when Control-Meta-c is being pressed":
1147
1148 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149
1150If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1151is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1152manpage. For example, the F<selection> extension (activated via
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154
1155 URxvt.keysym.M-C-c: perl:selection:rot13
1156
1157Due the the large number of modifier combinations, a defined key mapping
1158will match if at I<at least> the specified identifiers are being set, and
1159no other key mappings with those and more bits are being defined. That
1160means that defining a key map for C<a> will automatically provide
1161definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1162mappings themselves.
1163
1164Unfortunately, this will override built-in key mappings. For example
1165if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1166C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1167user-defined keymap using the C<builtin:> replacement:
1168
1169 URxvt.keysym.Insert: <my insert key sequence>
1170 URxvt.keysym.S-Insert: builtin:
1171
1172The first line defines a mapping for C<Insert> and I<any> combination
1173of modifiers. The second line re-establishes the default mapping for
1174C<Shift-Insert>.
1175
1176The following example will map Control-Meta-1 and Control-Meta-2 to
1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1178font-switching at runtime:
1179
1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1181 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1182
1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1184info):
1185
1186 URxvt.keysym.M-C-3: command:\033[8;25;80t
1187 URxvt.keysym.M-C-4: command:\033[8;48;110t
1188
1189=item B<perl-ext-common>: I<string>
1190
1191=item B<perl-ext>: I<string>
1192
1193Comma-separated list(s) of perl extension scripts (default: C<default>) to
1194use in this terminal instance; option B<-pe>.
1195
1196Extension names can be prefixed with a C<-> sign to prohibit using
1197them. This can be useful to selectively disable some extensions loaded
1198by default, or specified via the C<perl-ext-common> resource. For
1199example, C<default,-selection> will use all the default extension except
1200C<selection>.
1201
1202Extension names can also be followed by an argument in angle brackets
1203(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1204searchable scrollback to Alt/Meta-s). Mentioning the same extension
1205multiple times with different arguments will pass multiple arguments to
1206the extension.
1207
1208Each extension is looked up in the library directories, loaded if
1209necessary, and bound to the current terminal instance.
1210
1211If both of these resources are the empty string, then the perl
1212interpreter will not be initialized. The idea behind two options is that
1213B<perl-ext-common> will be used for extensions that should be available to
1214all instances, while B<perl-ext> is used for specific instances.
1215
1216=item B<perl-eval>: I<string>
1217
1218Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1220will be ignored when running setuid/setgid.
1221
1222=item B<perl-lib>: I<path>
1223
1224Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource,
1226@@RXVT_NAME@@ will first look in these directories and then in
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1228will be ignored when running setuid/setgid.
1229
1230See the @@RXVT_NAME@@perl(3) manpage.
1231
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233
1234Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1235details.
1236
1237=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1238
1239Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1240for details.
1241
1242=item B<searchable-scrollback:> I<keysym>
1243
1244Sets the hotkey that starts the incremental scrollback buffer search
1245(default: C<M-s>).
1246
1247=item B<urlLauncher>: I<string>
1248
1249Specifies the program to be started with a URL argument. Used by the
1250C<selection-popup> and C<matcher> perl extensions.
1251
1252=item B<transient-for>: I<windowid>
1253
1254Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1255
1256=item B<override-redirect>: I<boolean>
1257
1258Compile I<frills>: Sets override-redirect for the terminal window, making
1259it almost invisible to window managers; option B<-override-redirect>.
1260
1261=item B<iso14755_52:> I<boolean>
1262
1263Turn on/off ISO 14755 5.2 mode (default enabled).
805 1264
806=back 1265=back
807 1266
808=head1 THE SCROLLBAR 1267=head1 THE SCROLLBAR
809 1268
823the normal text selection/insertion, hold either the Shift or the Meta 1282the normal text selection/insertion, hold either the Shift or the Meta
824(Alt) key while performing the desired mouse action. 1283(Alt) key while performing the desired mouse action.
825 1284
826If mouse reporting mode is active, the normal scrollbar actions are 1285If mouse reporting mode is active, the normal scrollbar actions are
827disabled -- on the assumption that we are using a fullscreen 1286disabled -- on the assumption that we are using a fullscreen
828application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1287application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1288(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1289up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831respectively. 1290respectively.
832 1291
833=head1 TEXT SELECTION AND INSERTION 1292=head1 THE SELECTION: SELECTING AND PASTING TEXT
834 1293
835The behaviour of text selection and insertion mechanism is similar to 1294The behaviour of text selection and insertion/pasting mechanism is similar
836I<xterm>(1). 1295to I<xterm>(1).
837 1296
838=over 4 1297=over 4
839 1298
840=item B<Selection>: 1299=item B<Selecting>:
841 1300
842Left click at the beginning of the region, drag to the end of the 1301Left click at the beginning of the region, drag to the end of the region
843region and release; Right click to extend the marked region; Left 1302and release; Right click to extend the marked region; Left double-click
844double-click to select a word; Left triple-click to select the entire 1303to select a word; Left triple-click to select the entire logical line
845line. 1304(which can span multiple screen lines), unless modified by resource
1305B<tripleclickwords>.
846 1306
847Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1307Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848(Compile: frills) will create a rectangular selection instead of a normal 1308(Compile: I<frills>) will create a rectangular selection instead of a
849one. 1309normal one. In this mode, every selected row becomes its own line in the
1310selection, and trailing whitespace is visually underlined and removed from
1311the selection.
850 1312
851=item B<Insertion>: 1313=item B<Pasting>:
852 1314
853Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1315Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
854an B<@@RXVT_NAME@@> window causes the current text selection to be 1316window causes the value of the PRIMARY selection (or CLIPBOARD with the
855inserted as if it had been typed on the keyboard. 1317B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1318
1319Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1320inserted too.
856 1321
857=back 1322=back
858 1323
859=head1 CHANGING FONTS 1324=head1 CHANGING FONTS
860 1325
861Changing fonts (or font sizes, respectively) via the keypad is not yet 1326Changing fonts (or font sizes, respectively) via the keypad is not yet
862supported in rxvt-unicode. Bug me if you need this. 1327supported in rxvt-unicode. Bug me if you need this.
863 1328
864You can, however, switch fonts at runtime using escape sequences (and 1329You can, however, switch fonts at runtime using escape sequences, e.g.:
865therefore using the menubar), e.g.:
866 1330
867 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1331 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1332
1333You can use keyboard shortcuts, too:
1334
1335 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1336 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
868 1337
869rxvt-unicode will automatically re-apply these fonts to the output so far. 1338rxvt-unicode will automatically re-apply these fonts to the output so far.
870 1339
871=head1 ISO 14755 SUPPORT 1340=head1 ISO 14755 SUPPORT
872 1341
873ISO 14755 is a standard for entering and viewing unicode characters 1342ISO 14755 is a standard for entering and viewing unicode characters
874and character codes using the keyboard. It consists of 4 parts. The 1343and character codes using the keyboard. It consists of 4 parts. The
875first part is available rxvt-unicode has been compiled with 1344first part is available if rxvt-unicode has been compiled with
876C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1345C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877with C<--enable-iso14755>. 1346with C<--enable-iso14755>.
878 1347
879=over 4 1348=over 4
880 1349
881=item 5.1: Basic method 1350=item * 5.1: Basic method
882 1351
883This allows you to enter unicode characters using their hexcode. 1352This allows you to enter unicode characters using their hexcode.
884 1353
885Start by pressing and holding both C<Control> and C<Shift>, then enter 1354Start by pressing and holding both C<Control> and C<Shift>, then enter
886hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1355hex-digits (between one and six). Releasing C<Control> and C<Shift> will
893address, which you cannot type. Fortunately, the card has the e-mail 1362address, which you cannot type. Fortunately, the card has the e-mail
894address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1363address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1364by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896followed by releasing the modifier keys. 1365followed by releasing the modifier keys.
897 1366
898=item 5.2: Keyboard symbols entry method 1367=item * 5.2: Keyboard symbols entry method
899 1368
900This mode lets you input characters representing the keycap symbols of 1369This mode lets you input characters representing the keycap symbols of
901your keyboard, if representable in the current locale encoding. 1370your keyboard, if representable in the current locale encoding.
902 1371
903Start by pressing C<Control> and C<Shift> together, then releasing 1372Start by pressing C<Control> and C<Shift> together, then releasing
904them. The next special key (cursor keys, home etc.) you enter will not 1373them. The next special key (cursor keys, home etc.) you enter will not
905invoke it's usual function but instead will insert the corresponding 1374invoke its usual function but instead will insert the corresponding
906keycap symbol. The symbol will only be entered when the key has been 1375keycap symbol. The symbol will only be entered when the key has been
907released, otherwise pressing e.g. C<Shift> would enter the symbol for 1376released, otherwise pressing e.g. C<Shift> would enter the symbol for
908C<ISO Level 2 Switch>, although your intention might have been to enter a 1377C<ISO Level 2 Switch>, although your intention might have been to enter a
909reverse tab (Shift-Tab). 1378reverse tab (Shift-Tab).
910 1379
911=item 5.3: Screen-selection entry method 1380=item * 5.3: Screen-selection entry method
912 1381
913While this is implemented already (it's basically the selection 1382While this is implemented already (it's basically the selection
914mechanism), it could be extended by displaying a unicode character map. 1383mechanism), it could be extended by displaying a unicode character map.
915 1384
916=item 5.4: Feedback method for identifying displayed characters for later input 1385=item * 5.4: Feedback method for identifying displayed characters for later input
917 1386
918This method lets you display the unicode character code associated with 1387This method lets you display the unicode character code associated with
919characters already displayed. 1388characters already displayed.
920 1389
921You enter this mode by holding down C<Control> and C<Shift> together, then 1390You enter this mode by holding down C<Control> and C<Shift> together, then
933With respect to conformance, rxvt-unicode is supposed to be compliant to 1402With respect to conformance, rxvt-unicode is supposed to be compliant to
934both scenario A and B of ISO 14755, including part 5.2. 1403both scenario A and B of ISO 14755, including part 5.2.
935 1404
936=head1 LOGIN STAMP 1405=head1 LOGIN STAMP
937 1406
938B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1407B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
939that it can be seen via the I<who(1)> command, and can accept messages. 1408it can be seen via the I<who(1)> command, and can accept messages. To
940To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1409allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941some systems. 1410on some systems or setgid to root or to some other group on others.
942 1411
943=head1 COLORS AND GRAPHICS 1412=head1 COLORS AND GRAPHICS
944 1413
945In addition to the default foreground and background colours, 1414In addition to the default foreground and background colours,
946B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1415B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
947high-intensity bold/blink versions of the same). Here is a list of the 1416high-intensity bold/blink versions of the same). Here is a list of the
948colours with their B<rgb.txt> names. 1417colours with their names.
949 1418
950=begin table 1419=begin table
951 1420
952 B<color0> (black) = Black 1421 B<color0> (black) = Black
953 B<color1> (red) = Red3 1422 B<color1> (red) = Red3
973It is also possible to specify the colour values of B<foreground>, 1442It is also possible to specify the colour values of B<foreground>,
974B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
975a number 0-15, as a convenient shorthand to reference the colour name of 1444a number 0-15, as a convenient shorthand to reference the colour name of
976color0-color15. 1445color0-color15.
977 1446
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an
1448additional 72 colours. The first 64 of those (with indices 16 to 79)
1449consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
145016>), followed by 8 additional shades of gray (with indices 80 to 87).
1451
1452Together, all those colours implement the 88 colour xterm colours. Only
1453the first 16 can be changed using resources currently, the rest can only
1454be changed via command sequences ("escape codes").
1455
978Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
979always swapping the foreground/background colours. This is in contrast to 1457always swapping the foreground/background colours. This is in contrast to
980I<xterm>(1) where the colours are only swapped if they have not otherwise 1458I<xterm>(1) where the colours are only swapped if they have not otherwise
981been specified. For example, 1459been specified. For example,
982 1460
987would yield White on Black, while on I<xterm>(1) it would yield Black 1465would yield White on Black, while on I<xterm>(1) it would yield Black
988on White. 1466on White.
989 1467
990=back 1468=back
991 1469
1470=head2 ALPHA CHANNEL SUPPORT
1471
1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1473their act together, rxvt-unicode will do it's own alpha channel management:
1474
1475You can prefix any color with an opaquenes percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477(0-100) that specifies the opacity of the color, where C<0> is completely
1478transparent and C<100> is completely opaque. For example, C<[50]red> is a
1479half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with
1481all ways to specify a colour.
1482
1483For complete control, rxvt-unicode also supports
1484C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1485specifications, where the additional C<aaaa> component specifies opacity
1486(alpha) values. The minimum value of C<0000> is completely transparent,
1487while C<ffff> is completely opaque). The two example colours from
1488earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1489C<rgba:0000/ff00/0000/f332>.
1490
1491You probably need to specify B<"-depth 32">, too, to force a visual with
1492alpha channels, and have the luck that your X-server uses ARGB pixel
1493layout, as X is far from just supporting ARGB visuals out of the box, and
1494rxvt-unicode just fudges around.
1495
1496For example, the following selects an almost completely transparent black
1497background, and an almost opaque pink foreground:
1498
1499 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1500
1501When not using a background image, then the interpretation of the
1502alpha channel is up to your compositing manager (most interpret it as
1503transparency of course).
1504
1505When using a background pixmap or pseudo-transparency, then the background
1506colour will always behave as if it were completely transparent (so the
1507background image shows instead), regardless of how it was specified, while
1508other colours will either be transparent as specified (the background
1509image will show through) on servers supporting the RENDER extension, or
1510fully opaque on servers not supporting the RENDER EXTENSION.
1511
1512Please note that due to bugs in Xft, specifying alpha values might result
1513in garbage being displayed when the X-server does not support the RENDER
1514extension.
1515
992=head1 ENVIRONMENT 1516=head1 ENVIRONMENT
993 1517
994B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1518B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1519
996window id number of the B<@@RXVT_NAME@@> window and it also uses and 1520=over 4
997sets the environment variable B<DISPLAY> to specify which display 1521
998terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1522=item B<TERM>
999B<RXVTPATH> and B<PATH> to find XPM files. 1523
1524Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1525resources or on the command line.
1526
1527=item B<COLORTERM>
1528
1529Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1530compiled with background image support, and optionally with the added
1531extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1532screen.
1533
1534=item B<COLORFGBG>
1535
1536Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1537the colour code used as default foreground/text colour (or the string
1538C<default> to indicate that the default-colour escape sequence is to be
1539used), C<bg> is the colour code used as default background colour (or the
1540string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1541was compiled with background image support. Libraries like C<ncurses>
1542and C<slang> can (and do) use this information to optimize screen output.
1543
1544=item B<WINDOWID>
1545
1546Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1547window, which usually has subwindows for the scrollbar, the terminal
1548window and so on).
1549
1550=item B<TERMINFO>
1551
1552Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1553C<--with-terminfo=PATH>.
1554
1555=item B<DISPLAY>
1556
1557Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1558display in its child processes.
1559
1560=item B<SHELL>
1561
1562The shell to be used for command execution, defaults to C</bin/sh>.
1563
1564=item B<RXVT_SOCKET>
1565
1566The unix domain socket path used by @@RXVT_NAME@@c(1) and
1567@@RXVT_NAME@@d(1).
1568
1569Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1570
1571=item B<HOME>
1572
1573Used to locate the default directory for the unix domain socket for
1574daemon communications and to locate various resource files (such as
1575C<.Xdefaults>)
1576
1577=item B<XAPPLRESDIR>
1578
1579Directory where various X resource files are being located.
1580
1581=item B<XENVIRONMENT>
1582
1583If set and accessible, gives the name of a X resource file to be loaded by
1584@@RXVT_NAME@@.
1585
1586=back
1000 1587
1001=head1 FILES 1588=head1 FILES
1002 1589
1003=over 4 1590=over 4
1004 1591
1005=item B</etc/utmp>
1006
1007System file for login records.
1008
1009=item B</usr/lib/X11/rgb.txt> 1592=item B</usr/lib/X11/rgb.txt>
1010 1593
1011Color names. 1594Color names.
1012 1595
1013=back 1596=back
1014 1597
1015=head1 SEE ALSO 1598=head1 SEE ALSO
1016 1599
1017@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1600@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1018
1019=head1 BUGS
1020
1021Check the BUGS file for an up-to-date list.
1022
1023Cursor change support is not yet implemented.
1024
1025Click-and-drag doesn't work with X11 mouse report overriding.
1026 1601
1027=head1 CURRENT PROJECT COORDINATOR 1602=head1 CURRENT PROJECT COORDINATOR
1028 1603
1029=over 4 1604=over 4
1030 1605
1031=item Project Coordinator 1606=item Project Coordinator
1032 1607
1033@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1608Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1034 1609
1035=item Web page maintainter 1610L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1036
1037@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038
1039L<@@RXVT_WEBPAGE@@>
1040 1611
1041=back 1612=back
1042 1613
1043=head1 AUTHORS 1614=head1 AUTHORS
1044 1615
1066 1637
1067Project Coordinator (changes.txt 2.21a to 2.4.5) 1638Project Coordinator (changes.txt 2.21a to 2.4.5)
1068 1639
1069=item Geoff Wing L<< <gcw@pobox.com> >> 1640=item Geoff Wing L<< <gcw@pobox.com> >>
1070 1641
1071Rewrote screen display and text selection routines. Project Coordinator 1642Rewrote screen display and text selection routines.
1643
1072(changes.txt 2.4.6 - rxvt-unicode) 1644Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1073 1645
1074=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1646=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1075 1647
1076Forked rxvt-unicode, rewrote most of the display code and internal 1648Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1077character handling to store text in unicode, improve xterm 1649extension, random hacks, numerous bugfixes and extensions.
1078compatibility and apply numerous other bugfixes and extensions.
1079 1650
1080Project Coordinator (Changes 1.0 -) 1651Project Coordinator (Changes 1.0 -)
1081 1652
1653=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1654
1655Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1656
1082=back 1657=back
1083 1658

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines