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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines