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.136 by root, Mon Aug 13 10:01:18 2007 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
102 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
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
103=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
104 118
105Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
106 120
107=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 128
115=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
116 130
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118
119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
120
121Turn on/off inheriting parent window's pixmap. Alternative form is
122B<-tr>; resource B<inheritPixmap>.
123
124I<Please note that transparency of any kind if completely unsupported by
125the author. Don't bug him with installation questions! Read the FAQ (man 7
126@@RXVT_NAME@@)!>
127 132
128=item B<-fade> I<number> 133=item B<-fade> I<number>
129 134
130Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
131fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
134=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
135 140
136Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
137is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
138 143
139=item B<-tint> I<colour> 144=item B<-icon> I<file>
140 145
141Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
142transparency is enabled with B<-tr> or B<-ip>. This only works for 147is used by many window managers, taskbars and pagers to represent the
143non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application window; resource I<iconFile>.
144used to brighten or darken the image in addition to tinting it.
145Please note that certain tint colours can be applied on the server-side,
146thus yielding performance gain of two orders of magnitude. These colours are:
147blue, red, green, cyan, magenta, yellow, and those close to them; resource
148I<tintColor>. Example:
149
150 @@RXVT_NAME@@ -tr -tint blue -sh 40
151
152=item B<-sh> I<number>
153
154Darken (0 .. 100) or lighten (-1 .. -100) the transparent
155background image in addition to (or instead of) tinting it;
156resource I<shading>.
157
158=item B<-blt> I<string>
159
160Specify background blending type. If background pixmap is specified
161at the same time as transparency - such pixmap will be blended over
162transparency image, using method specified. Supported values are :
163B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166alpha-blending; resource I<blendType>.
167
168=item B<-blr> I<HxV>
169
170Apply Gaussian Blur with the specified radii to the transparent
171background image. If single number is specified - both vertical and
172horizontal radii are considered to be the same. Setting one of the
173radii to 1 and another to a large number creates interesting effects
174on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
175 149
176=item B<-bg> I<colour> 150=item B<-bg> I<colour>
177 151
178Window background colour; resource B<background>. 152Window background colour; resource B<background>.
179 153
180=item B<-fg> I<colour> 154=item B<-fg> I<colour>
181 155
182Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
183
184=item B<-pixmap> I<file[;geom]>
185
186Compile I<afterimage>: Specify image file for the background and also
187optionally specify its scaling with a geometry string. Note you may need to
188add quotes to avoid special shell interpretation of the C<;> in the
189command-line; for more details see resource B<backgroundPixmap>.
190 157
191=item B<-cr> I<colour> 158=item B<-cr> I<colour>
192 159
193The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
194 161
239italic> >> characters are to be printed. See resource B<boldItalicFont> 206italic> >> characters are to be printed. See resource B<boldItalicFont>
240for details. 207for details.
241 208
242=item B<-is>|B<+is> 209=item B<-is>|B<+is>
243 210
244Compile I<font-styles>: Bold/Italic font styles imply high intensity 211Compile I<font-styles>: Bold/Blink font styles imply high intensity
245foreground/background (default). See resource B<intensityStyles> for 212foreground/background (default). See resource B<intensityStyles> for
246details. 213details.
247 214
248=item B<-name> I<name> 215=item B<-name> I<name>
249 216
253 220
254=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
255 222
256Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
257 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
258=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
259 230
260Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
261B<utmpInhibit>. 232B<utmpInhibit>.
262 233
266B<visualBell>. 237B<visualBell>.
267 238
268=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
269 240
270Turn on/off scrollbar; resource B<scrollBar>. 241Turn on/off scrollbar; resource B<scrollBar>.
242
243=item B<-sr>|B<+sr>
244
245Put scrollbar on right/left; resource B<scrollBar_right>.
246
247=item B<-st>|B<+st>
248
249Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
250resource B<scrollBar_floating>.
271 251
272=item B<-si>|B<+si> 252=item B<-si>|B<+si>
273 253
274Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
275B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
282=item B<-sw>|B<+sw> 262=item B<-sw>|B<+sw>
283 263
284Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
285This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
286B<scrollWithBuffer>. 266B<scrollWithBuffer>.
287
288=item B<-sr>|B<+sr>
289
290Put scrollbar on right/left; resource B<scrollBar_right>.
291
292=item B<-st>|B<+st>
293
294Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
295resource B<scrollBar_floating>.
296 267
297=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
298 269
299If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
300actual wide characters in the screen buffer, which makes it possible to 271actual wide characters in the screen buffer, which makes it possible to
304 275
305=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
306 277
307Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
308 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
309=item B<-iconic> 284=item B<-iconic>
310 285
311Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
312Alternative form is B<-ic>. 287Alternative form is B<-ic>.
313 288
329 304
330=item B<-bl> 305=item B<-bl>
331 306
332Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile I<frills>: Set MWM hints to request a borderless window, i.e.
333if honoured by the WM, the rxvt-unicode window will not have window 308if honoured by the WM, the rxvt-unicode window will not have window
334decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
335 311
336=item B<-override-redirect> 312=item B<-override-redirect>
337 313
338Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
339B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
340 321
341=item B<-sbg> 322=item B<-sbg>
342 323
343Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
344drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
347 328
348=item B<-lsp> I<number> 329=item B<-lsp> I<number>
349 330
350Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
351the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
352B<linespace>. 333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
353 341
354=item B<-tn> I<termname> 342=item B<-tn> I<termname>
355 343
356This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
357B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
392=item B<-pt> I<style> 380=item B<-pt> I<style>
393 381
394Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
395B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
396 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
397=item B<-im> I<text> 388=item B<-im> I<text>
398 389
399Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
400 391
401=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
412 403
413=item B<-tcw> 404=item B<-tcw>
414 405
415Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
416button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
417in-use. Instead of selecting a full line it will extend the selection the 408in-use. Instead of selecting a full line it will extend the selection to
418end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
419 410
420=item B<-insecure> 411=item B<-insecure>
421 412
422Enable "insecure" mode, which currently enables most of the escape 413Enable "insecure" mode, which currently enables most of the escape
423sequences that echo strings. See the resource B<insecure> for more 414sequences that echo strings. See the resource B<insecure> for more
443 434
444Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
445will not immediately destroy its window when the program executed within 436will not immediately destroy its window when the program executed within
446it exits. Instead, it will wait till it is being killed or closed by the 437it exits. Instead, it will wait till it is being killed or closed by the
447user; resource B<hold>. 438user; resource B<hold>.
439
440=item B<-cd> I<path>
441
442Sets the working directory for the shell (or the command specified via
443B<-e>). The I<path> must be an absolute path and it must exist for
444@@RXVT_NAME@@ to start; resource B<chdir>.
445
446=item B<-xrm> I<string>
447
448Works like the X Toolkit option of the same name, by adding the I<string>
449as if it were specified in a resource file. Resource values specified this
450way take precedence over all other resource specifications.
451
452Note that you need to use the I<same> syntax as in the .Xdefaults file,
453e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
454options can be specified as long-options on the commandline, so use
455of B<-xrm> is mostly limited to cases where you want to specify other
456resources (e.g. for input methods) or for compatibility with other
457programs.
448 458
449=item B<-keysym.>I<sym> I<string> 459=item B<-keysym.>I<sym> I<string>
450 460
451Remap a key symbol. See resource B<keysym>. 461Remap a key symbol. See resource B<keysym>.
452 462
487If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 497If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
488entries and will not tinker with pty/tty permissions - you have to do that 498entries and will not tinker with pty/tty permissions - you have to do that
489yourself if you want that. 499yourself if you want that.
490 500
491As an extremely special case, specifying C<-1> will completely suppress 501As an extremely special case, specifying C<-1> will completely suppress
492pty/tty operations. 502pty/tty operations, which is probably only useful in conjunction with some
503perl extension that manages the terminal.
493 504
494Here is a example in perl that illustrates how this option can be used (a 505Here is a example in perl that illustrates how this option can be used (a
495longer example is in F<doc/pty-fd>): 506longer example is in F<doc/pty-fd>):
496 507
497 use IO::Pty; 508 use IO::Pty;
511Comma-separated list of perl extension scripts to use (or not to use) in 522Comma-separated list of perl extension scripts to use (or not to use) in
512this terminal instance. See resource B<perl-ext> for details. 523this terminal instance. See resource B<perl-ext> for details.
513 524
514=back 525=back
515 526
516=head1 RESOURCES (available also as long-options) 527=head1 RESOURCES
517 528
518Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 529Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
519options) compiled into your version. 530options) compiled into your version. All resources are also available as
531long-options.
520 532
521You can set and change the resources using X11 tools like B<xrdb>. Many 533You can set and change the resources using X11 tools like B<xrdb>. Many
522distribution do also load settings from the B<~/.Xresources> file when X 534distribution do also load settings from the B<~/.Xresources> file when X
523starts. @@RXVT_NAME@@ will consult the following files/resources in order, 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
524with later settings overwriting earlier ones: 536with later settings overwriting earlier ones:
525 537
526 1. system-wide app-defaults file, either locale-dependent OR global
527 2. app-defaults file in $XAPPLRESDIR 538 1. app-defaults file in $XAPPLRESDIR
539 2. $HOME/.Xdefaults
528 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 540 3. RESOURCE_MANAGER property on root-window of screen 0
529 4. SCREEN_RESOURCES for the current screen 541 4. SCREEN_RESOURCES property on root-window of the current screen
530 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
543 6. resources specified via -xrm on the commandline
531 544
532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 546names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
534common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 547common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
535configured, while the class name B<URxvt> allows resources unique to 548configured, while the class name B<URxvt> allows resources unique to
545=item B<depth:> I<bitdepth> 558=item B<depth:> I<bitdepth>
546 559
547Compile I<xft>: Attempt to find a visual with the given bit depth; 560Compile I<xft>: Attempt to find a visual with the given bit depth;
548option B<-depth>. 561option B<-depth>.
549 562
563=item B<buffered:> I<boolean>
564
565Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
566On some card/driver combination enabling it slightly decreases
567performance, on most it greatly helps it. The slowdown is small, so it
568should normally be enabled.
569
550=item B<geometry:> I<geom> 570=item B<geometry:> I<geom>
551 571
552Create the window with the specified X window geometry [default 80x24]; 572Create the window with the specified X window geometry [default 80x24];
553option B<-geometry>. 573option B<-geometry>.
554 574
567Use the specified colour for the colour value I<n>, where 0-7 587Use the specified colour for the colour value I<n>, where 0-7
568corresponds to low-intensity (normal) colours and 8-15 corresponds to 588corresponds to low-intensity (normal) colours and 8-15 corresponds to
569high-intensity (bold = bright foreground, blink = bright background) 589high-intensity (bold = bright foreground, blink = bright background)
570colours. The canonical names are as follows: 0=black, 1=red, 2=green, 590colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5713=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5913=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
572names used are listed in the B<COLORS AND GRAPHICS> section. 592names used are listed in the B<COLOURS AND GRAPHICS> section.
573 593
574Colours higher than 15 cannot be set using resources (yet), but can be 594Colours higher than 15 cannot be set using resources (yet), but can be
575changed using an escape command (see @@RXVT_NAME@@(7)). 595changed using an escape command (see @@RXVT_NAME@@(7)).
576 596
577Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 597Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
588=item B<colorUL:> I<colour> 608=item B<colorUL:> I<colour>
589 609
590Use the specified colour to display underlined characters when the 610Use the specified colour to display underlined characters when the
591foreground colour is the default. 611foreground colour is the default.
592 612
593=item B<colorRV:> I<colour>
594
595Use the specified colour as the background for reverse video characters
596when OPTION_HC is disabled (--disable-frills).
597
598=item B<underlineColor:> I<colour> 613=item B<underlineColor:> I<colour>
599 614
600If set, use the specified colour as the colour for the underline 615If set, use the specified colour as the colour for the underline
601itself. If unset, use the foreground colour. 616itself. If unset, use the foreground colour.
617
618=item B<highlightColor:> I<colour>
619
620If set, use the specified colour as the background for highlighted
621characters. If unset, use reverse video.
622
623=item B<highlightTextColor:> I<colour>
624
625If set and highlightColor is set, use the specified colour as the
626foreground for highlighted characters.
602 627
603=item B<cursorColor:> I<colour> 628=item B<cursorColor:> I<colour>
604 629
605Use the specified colour for the cursor. The default is to use the 630Use the specified colour for the cursor. The default is to use the
606foreground colour; option B<-cr>. 631foreground colour; option B<-cr>.
613 638
614=item B<reverseVideo:> I<boolean> 639=item B<reverseVideo:> I<boolean>
615 640
616B<True>: simulate reverse video by foreground and background colours; 641B<True>: simulate reverse video by foreground and background colours;
617option B<-rv>. B<False>: regular screen colours [default]; option 642option B<-rv>. B<False>: regular screen colours [default]; option
618B<+rv>. See note in B<COLORS AND GRAPHICS> section. 643B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
619 644
620=item B<jumpScroll:> I<boolean> 645=item B<jumpScroll:> I<boolean>
621 646
622B<True>: specify that jump scrolling should be used. When receiving lots 647B<True>: specify that jump scrolling should be used. When receiving lots
623of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 648of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
637 662
638B<False>: specify that everything is to be displayed, even 663B<False>: specify that everything is to be displayed, even
639if the refresh is too fast for the human eye to read anything (or the 664if the refresh is too fast for the human eye to read anything (or the
640monitor to display anything); option B<+ss>. 665monitor to display anything); option B<+ss>.
641 666
642=item B<inheritPixmap:> I<boolean>
643
644B<True>: make the background inherit the parent windows' pixmap, giving
645artificial transparency. B<False>: do not inherit the parent windows'
646pixmap.
647
648I<Please note that transparency of any kind if completely unsupported by
649the author. Don't bug him with installation questions!>
650
651=item B<fading:> I<number> 667=item B<fading:> I<number>
652 668
653Fade the text by the given percentage when focus is lost; option B<-fade>. 669Fade the text by the given percentage when focus is lost; option B<-fade>.
654 670
655=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
656 672
657Fade to this colour, when fading is used (see B<fading:>). The default 673Fade to this colour, when fading is used (see B<fading:>). The default
658colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
659 675
660=item B<tintColor:> I<colour> 676=item B<iconFile:> I<file>
661 677
662Tint the transparent background pixmap with the given colour; option 678Set the application icon pixmap; option B<-icon>.
663B<-tint>.
664
665=item B<shading:> I<number>
666
667Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
668in addition to tinting it; option B<-sh>.
669
670=item B<blendType:> I<string>
671
672Specify background blending type; option B<-blt>.
673
674=item B<blurRadius:> I<number>
675
676Apply Gaussian Blurr with the specified radius to the transparent
677background image; option B<-blr>.
678 679
679=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
680 681
681Use the specified colour for the scrollbar [default #B2B2B2]. 682Use the specified colour for the scrollbar [default #B2B2B2].
682 683
687 688
688=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
689 690
690The colour of the border around the text area and between the scrollbar 691The colour of the border around the text area and between the scrollbar
691and the text. 692and the text.
692
693=item B<backgroundPixmap:> I<file[;geom]>
694
695Use the specified image file for the background and also optionally
696specify its scaling with a geometry string B<WxH+X+Y>,
697in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
698and B<"X" / "Y"> locate the image centre (percent).
699A scale of 0 displays the image with tiling. A scale of 1 displays the
700image without any scaling. A scale of 2 to 9 specifies an integer
701number of images in that direction. No image will be magnified beyond
70210 times its original size. The maximum permitted scale is 1000.
703Special string of B<"auto"> used as a geometry will cause image to be
704automatically scaled to match window size.
705If used in conjunction with B<-tr> option - specified pixmap will be
706blended over transparency image using either alpha-blending, or any
707other blending type, specified with B<-blt "type"> option.
708[default 0x0+50+50]
709
710=item B<path:> I<path>
711
712Specify the colon-delimited search path for finding XPM files.
713 693
714=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
715 695
716Select the fonts to be used. This is a comma separated list of font names 696Select the fonts to be used. This is a comma separated list of font names
717that are checked in order when trying to find glyphs for characters. The 697that are checked in order when trying to find glyphs for characters. The
740it is named first) and thus defines the character cell grid to be 9 pixels 720it is named first) and thus defines the character cell grid to be 9 pixels
741wide and 15 pixels high. 721wide and 15 pixels high.
742 722
743The second font is just used to add additional unicode characters not in 723The second font is just used to add additional unicode characters not in
744the base font, likewise the third, which is unfortunately non-bold, but 724the base font, likewise the third, which is unfortunately non-bold, but
745the bold version of the font does contain less characters, so this is a 725the bold version of the font does contain fewer characters, so this is a
746useful supplement. 726useful supplement.
747 727
748The third font is an Xft font with aliasing turned off, and the characters 728The third font is an Xft font with aliasing turned off, and the characters
749are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 729are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
750contains other characters, but we are not interested in them. 730contains other characters, but we are not interested in them.
774text font will being used for the given style. 754text font will being used for the given style.
775 755
776=item B<intensityStyles:> I<boolean> 756=item B<intensityStyles:> I<boolean>
777 757
778When font styles are not enabled, or this option is enabled (B<True>, 758When font styles are not enabled, or this option is enabled (B<True>,
779option B<-is>, the default), bold and italic font styles imply high 759option B<-is>, the default), bold/blink font styles imply high
780intensity foreground/background colours. Disabling this option (B<False>, 760intensity foreground/background colours. Disabling this option (B<False>,
781option B<+is>) disables this behaviour, the high intensity colours are not 761option B<+is>) disables this behaviour, the high intensity colours are not
782reachable. 762reachable.
783 763
784=item B<selectstyle:> I<mode>
785
786Set mouse selection style to B<old> which is 2.20, B<oldword> which
787is xterm style with 2.20 old word selection, or anything else which
788gives xterm style selection. Only effective when the original (non-perl)
789selection code is in use.
790
791=item B<scrollstyle:> I<mode>
792
793Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
794the author's favourite.
795
796=item B<title:> I<string> 764=item B<title:> I<string>
797 765
798Set window title string, the default title is the command-line 766Set window title string, the default title is the command-line
799specified after the B<-e> option, if any, otherwise the application 767specified after the B<-e> option, if any, otherwise the application
800name; option B<-title>. 768name; option B<-title>.
813=item B<urgentOnBell:> I<boolean> 781=item B<urgentOnBell:> I<boolean>
814 782
815B<True>: set the urgency hint for the wm on receipt of a bell character. 783B<True>: set the urgency hint for the wm on receipt of a bell character.
816B<False>: do not set the urgency hint [default]. 784B<False>: do not set the urgency hint [default].
817 785
786@@RXVT_NAME@@ resets the urgency hint on every focus change.
787
818=item B<visualBell:> I<boolean> 788=item B<visualBell:> I<boolean>
819 789
820B<True>: use visual bell on receipt of a bell character; option B<-vb>. 790B<True>: use visual bell on receipt of a bell character; option B<-vb>.
821B<False>: no visual bell [default]; option B<+vb>. 791B<False>: no visual bell [default]; option B<+vb>.
822 792
824 794
825B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 795B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
826the shell; option B<-ls>. B<False>: start as a normal sub-shell 796the shell; option B<-ls>. B<False>: start as a normal sub-shell
827[default]; option B<+ls>. 797[default]; option B<+ls>.
828 798
799=item B<multiClickTime:> I<number>
800
801Specify the maximum time in milliseconds between multi-click select
802events. The default is 500 milliseconds; option B<-mc>.
803
829=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
830 805
831B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
832option B<-ut>. B<False>: write record into the system log file B<utmp> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
833[default]; option B<+ut>. 808[default]; option B<+ut>.
845 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 820 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
846 821
847This creates a new file in your home directory with the screen contents 822This creates a new file in your home directory with the screen contents
848every time you hit C<Print>. 823every time you hit C<Print>.
849 824
825=item B<scrollstyle:> I<mode>
826
827Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
828the author's favourite.
829
830=item B<thickness:> I<number>
831
832Set the scrollbar width in pixels.
833
850=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
851 835
852B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
853disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
854 838
873B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
874B<+si>. 858B<+si>.
875 859
876=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
877 861
878B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
879B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
880with scrollback buffer when tty receives new lines; option B<+sw>. 864B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
865new lines; option B<+sw>.
881 866
882=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
883 868
884B<True>: scroll to bottom when a non-special key is pressed. Special keys 869B<True>: scroll to bottom when a non-special key is pressed. Special keys
885are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
916=item B<termName:> I<termname> 901=item B<termName:> I<termname>
917 902
918Specifies the terminal type name to be set in the B<TERM> environment 903Specifies the terminal type name to be set in the B<TERM> environment
919variable; option B<-tn>. 904variable; option B<-tn>.
920 905
921=item B<linespace:> I<number> 906=item B<lineSpace:> I<number>
922 907
923Specifies number of lines (pixel height) to insert between each row of 908Specifies number of lines (pixel height) to insert between each row of
924the display [default 0]; option B<-lsp>. 909the display [default 0]; option B<-lsp>.
925 910
926=item B<meta8:> I<boolean> 911=item B<meta8:> I<boolean>
940 925
941=item B<cursorBlink:> I<boolean> 926=item B<cursorBlink:> I<boolean>
942 927
943B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 928B<True>: blink the cursor. B<False>: do not blink the cursor [default];
944option B<-bc>. 929option B<-bc>.
930
931=item B<cursorUnderline:> I<boolean>
932
933B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
934option B<-uc>.
945 935
946=item B<pointerBlank:> I<boolean> 936=item B<pointerBlank:> I<boolean>
947 937
948B<True>: blank the pointer when a key is pressed or after a set number 938B<True>: blank the pointer when a key is pressed or after a set number
949of seconds of inactivity. B<False>: the pointer is always visible 939of seconds of inactivity. B<False>: the pointer is always visible
955 945
956=item B<pointerColor2:> I<colour> 946=item B<pointerColor2:> I<colour>
957 947
958Mouse pointer background colour. 948Mouse pointer background colour.
959 949
950=item B<pointerShape:> I<string>
951
952Compile I<frills>: Specifies the name of the mouse pointer shape
953[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
954file for possible values (omit the C<XC_> prefix).
955
960=item B<pointerBlankDelay:> I<number> 956=item B<pointerBlankDelay:> I<number>
961 957
962Specifies number of seconds before blanking the pointer [default 2]. Use a 958Specifies number of seconds before blanking the pointer [default 2]. Use a
963large number (e.g. C<987654321>) to effectively disable the timeout. 959large number (e.g. C<987654321>) to effectively disable the timeout.
964 960
965=item B<backspacekey:> I<string> 961=item B<backspacekey:> I<string>
966 962
967The string to send when the backspace key is pressed. If set to B<DEC> 963The string to send when the backspace key is pressed. If set to B<DEC>
968or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 964or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
969(code 8) - which can be reversed with the appropriate DEC private mode 965(code 8) - which can be reversed with the appropriate DEC private mode
970escape sequence. 966escape sequence.
971 967
972=item B<deletekey:> I<string> 968=item B<deletekey:> I<string>
973 969
986will be created). In this mode, characters outside ISO-8859-1 can be used. 982will be created). In this mode, characters outside ISO-8859-1 can be used.
987 983
988When the selection extension is not used, only ISO-8859-1 characters can 984When the selection extension is not used, only ISO-8859-1 characters can
989be used. If not specified, the built-in default is used: 985be used. If not specified, the built-in default is used:
990 986
991B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 987B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
992 988
993=item B<preeditType:> I<style> 989=item B<preeditType:> I<style>
994 990
995B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 991B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
996 992
997=item B<inputMethod:> I<name> 993=item B<inputMethod:> I<name>
998 994
999I<name> of inputMethod to use; option B<-im>. 995I<name> of inputMethod to use; option B<-im>.
1000 996
1052 1048
1053=item B<secondaryScroll:> I<boolean> 1049=item B<secondaryScroll:> I<boolean>
1054 1050
1055Turn on/off secondary screen scroll (default enabled). If this 1051Turn on/off secondary screen scroll (default enabled). If this
1056option is enabled, scrolls on the secondary screen will change the 1052option is enabled, scrolls on the secondary screen will change the
1057scrollback buffer and switching to/from the secondary screen will 1053scrollback buffer and, when secondaryScreen is off, switching
1058instead scroll the screen up. 1054to/from the secondary screen will instead scroll the screen up.
1059 1055
1060=item B<hold>: I<boolean> 1056=item B<hold>: I<boolean>
1061 1057
1062Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1058Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1063will not immediately destroy its window when the program executed within 1059will not immediately destroy its window when the program executed within
1064it exits. Instead, it will wait till it is being killed or closed by the 1060it exits. Instead, it will wait till it is being killed or closed by the
1065user. 1061user.
1066 1062
1063=item B<chdir>: I<path>
1064
1065Sets the working directory for the shell (or the command specified via
1066B<-e>). The I<path> must be an absolute path and it must exist for
1067@@RXVT_NAME@@ to start. If it isn't specified then the current working
1068directory will be used; option B<-cd>.
1069
1067=item B<keysym.>I<sym>: I<string> 1070=item B<keysym.>I<sym>: I<action>
1068 1071
1069Compile I<frills>: Associate I<string> with keysym I<sym>. The 1072Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1070intervening resource name B<keysym.> cannot be omitted. 1073resource name B<keysym.> cannot be omitted.
1071 1074
1072The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1075Using this resource, you can map key combinations such as
1073any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1076C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1074B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1077string than would normally result from that combination, making the
1075and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1078terminal scroll up or down the way you want it, or any other thing an
1076B<2>, B<3>, B<4>, B<5>. 1079extension might provide.
1080
1081The key combination that triggers the action, I<sym>, has the following format:
1082
1083 (modifiers-)key
1084
1085Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1086B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1087B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1088B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1077 1089
1078The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1090The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1079whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1091whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1080keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1092keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1081current application keymap mode state. 1093current application keymap mode state.
1082 1094
1083The spellings of I<key> can be obtained by using B<xev>(1) command or 1095Due the the large number of modifier combinations, a key mapping will
1084searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1096match if I<at least> the specified identifiers are being set, and no other
1097key mappings with those and more bits are being defined. That means that
1098defining a mapping for C<a> will automatically provide definitions for
1099C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1100themselves. See the C<builtin:> action, below, for a way to work around
1101this when this is a problem.
1102
1103The spelling of I<key> depends on your implementation of X. An easy way to
1104find a key name is to use the B<xev>(1) command. You can find a list by
1105looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1085omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1106the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1086keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1107value (B<0x0000 - 0xFFFF>).
1087performed in an exact manner; however, the closest match is assured.
1088 1108
1089I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1109As with any resource value, the I<action> string may contain backslash
1090C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1110escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1091C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1111number), see RESOURCES in C<man 7 X> for further details.
1092C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1093can start or end with whitespace. B<This feature is deprecated and will
1094be removed>.
1095 1112
1096Please note that you need to double the C<\> in resource files, as 1113An action starts with an action prefix that selects a certain type
1097Xlib itself does its own de-escaping (you can use C<\033> instead of 1114of action, followed by a colon. An action string without colons is
1098C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1115interpreted as a literal string to pass to the tty (as if it was
1099processing). 1116prefixed with C<string:>).
1100 1117
1101You can define a range of keysyms in one shot by providing a I<string> 1118The following action prefixes are known - extensions can provide
1102with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1119additional prefixes:
1120
1121=over 4
1122
1123=item string:STRING
1124
1125If the I<action> starts with C<string:> (or otherwise contains no colons),
1126then the remaining C<STRING> will be passed to the program running in the
1127terminal. For example, you could replace whatever Shift-Tab outputs by the
1128string C<echo rm -rf /> followed by a newline:
1129
1130 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1131
1132This could in theory be used to completely redefine your keymap.
1133
1134In addition, for actions of this type, you can define a range of
1135keysyms in one shot by loading the C<keysym-list> perl extension and
1136providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1103should be a character not used by the strings. 1137the delimiter `/' should be a character not used by the strings.
1104 1138
1105Its usage can be demonstrated by an example: 1139Its usage can be demonstrated by an example:
1106 1140
1107 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1141 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1108 1142
1109The above line is equivalent to the following three lines: 1143The above line is equivalent to the following three lines:
1110 1144
1111 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1145 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1112 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1146 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1113 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1147 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1114 1148
1149=item command:STRING
1150
1115If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1151If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1116is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1152is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1153the opposite of C<string:> - instead of sending it to the program running
1154in the terminal, it will be treated as if it were program output). This is
1155most useful to feed command sequences into @@RXVT_NAME@@.
1156
1117example the following means "change the current locale to C<zh_CN.GBK> 1157For example the following means "change the current locale to C<zh_CN.GBK>
1118when Control-Meta-c is being pressed": 1158when Control-Meta-c is being pressed":
1119 1159
1120 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1160 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1121 1161
1122If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1162The following example will map Control-Meta-1 and Control-Meta-2 to
1123is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1163the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1124manpage. For example, the F<selection> extension (activated via 1164font-switching at runtime:
1125C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1126 1165
1127 URxvt.keysym.M-C-c: perl:selection:rot13 1166 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1167 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1128 1168
1129Due the the large number of modifier combinations, a defined key mapping 1169Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1130will match if at I<at least> the specified identifiers are being set, and 1170info):
1131no other key mappings with those and more bits are being defined. That
1132means that defining a key map for C<a> will automatically provide
1133definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1134mappings themselves.
1135 1171
1136Unfortunately, this will override built-in key mappings. For example 1172 URxvt.keysym.M-C-3: command:\033[8;25;80t
1173 URxvt.keysym.M-C-4: command:\033[8;48;110t
1174
1175=item builtin:
1176
1177The builtin action is the action that @@RXVT_NAME@@ would execute if no
1178key binding existed for the key combination. The obvious use is to undo
1179the effect of existing bindings. The not so obvious use is to reinstate
1180bindings when another binding overrides too many modifiers.
1181
1137if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1182For example if you overwrite the C<Insert> key you will disable
1138C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1183@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1139user-defined keymap using the C<builtin:> replacement: 1184"holes" into the user-defined keymap using the C<builtin:> replacement:
1140 1185
1141 URxvt.keysym.Insert: <my insert key sequence> 1186 URxvt.keysym.Insert: <my insert key sequence>
1142 URxvt.keysym.S-Insert: builtin: 1187 URxvt.keysym.S-Insert: builtin:
1143 1188
1144The first line defines a mapping for C<Insert> and I<any> combination 1189The first line defines a mapping for C<Insert> and I<any> combination
1145of modifiers. The second line re-establishes the default mapping for 1190of modifiers. The second line re-establishes the default mapping for
1146C<Shift-Insert>. 1191C<Shift-Insert>.
1147 1192
1148The following example will map Control-Meta-1 and Control-Meta-2 to 1193=item builtin-string:
1149the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1150font-switching at runtime:
1151 1194
1152 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1195This action is mainly useful to restore string mappings for keys that
1153 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1196have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1197difficult to explain - basically, this action will send the string to the
1198application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1199action for it.
1154 1200
1155Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1201An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1156info): 1202selection when you press C<Shift-Insert>. With the following bindings, it
1203would instead emit the (undocumented, but what applications running in the
1204terminal might expect) sequence C<ESC [ 2 $> instead:
1157 1205
1158 URxvt.keysym.M-C-3: command:\033[8;25;80t 1206 URxvt.keysym.S-Insert: builtin-string:
1159 URxvt.keysym.M-C-4: command:\033[8;48;110t 1207 URxvt.keysym.C-S-Insert: builtin:
1208
1209The first line disables the paste functionality for that key
1210combination, and the second reinstates the default behaviour for
1211C<Control-Shift-Insert>, which would otherwise be overridden.
1212
1213Similarly, to let applications gain access to the C<C-M-c> (copy to
1214clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1215this:
1216
1217 URxvt.keysym.C-M-c: builtin-string:
1218 URxvt.keysym.C-M-v: builtin-string:
1219
1220=item EXTENSION:STRING
1221
1222An action of this form invokes the action B<STRING>, if any, provided
1223by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1224be loaded automatically if necessary.
1225
1226Not all extensions define actions, but popular extensions that do
1227include the I<selection> and I<matcher> extensions (documented in their
1228own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1229respectively).
1230
1231From the silly examples department, this will rot13-"encrypt"
1232@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1233keyboards:
1234
1235 URxvt.keysym.M-C-c: selection:rot13
1236
1237=item perl:STRING *DEPRECATED*
1238
1239This is a deprecated way of invoking commands provided by perl
1240extensions. It is still supported, but should not be used anymore.
1241
1242=back
1160 1243
1161=item B<perl-ext-common>: I<string> 1244=item B<perl-ext-common>: I<string>
1162 1245
1163=item B<perl-ext>: I<string> 1246=item B<perl-ext>: I<string>
1164 1247
1166use in this terminal instance; option B<-pe>. 1249use in this terminal instance; option B<-pe>.
1167 1250
1168Extension names can be prefixed with a C<-> sign to prohibit using 1251Extension names can be prefixed with a C<-> sign to prohibit using
1169them. This can be useful to selectively disable some extensions loaded 1252them. This can be useful to selectively disable some extensions loaded
1170by default, or specified via the C<perl-ext-common> resource. For 1253by default, or specified via the C<perl-ext-common> resource. For
1171example, C<default,-selection> will use all the default extension except 1254example, C<default,-selection> will use all the default extensions except
1172C<selection>. 1255C<selection>.
1173 1256
1174Extension names can also be followed by an argument in angle brackets 1257The default set includes the C<selection>, C<option-popup>,
1175(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1258C<selection-popup>, C<readline> and C<searchable-scrollback>
1176searchable scrollback to Alt/Meta-s). Mentioning the same extension 1259extensions, and extensions which are mentioned in B<keysym> resources.
1177multiple times with different arguments will pass multiple arguments to 1260
1178the extension. 1261Any extension such that a corresponding resource is given on the
1262command line is automatically appended to B<perl-ext>.
1179 1263
1180Each extension is looked up in the library directories, loaded if 1264Each extension is looked up in the library directories, loaded if
1181necessary, and bound to the current terminal instance. 1265necessary, and bound to the current terminal instance. When the library
1266search path contains multiple extension files of the same name, then the
1267first one found will be used.
1182 1268
1183If both of these resources are the empty string, then the perl 1269If both of these resources are the empty string, then the perl interpreter
1184interpreter will not be initialized. The idea behind two options is that 1270will not be initialized. The rationale for having two options is that
1185B<perl-ext-common> will be used for extensions that should be available to 1271B<perl-ext-common> will be used for extensions that should be available to
1186all instances, while B<perl-ext> is used for specific instances. 1272all instances, while B<perl-ext> is used for specific instances.
1187 1273
1188=item B<perl-eval>: I<string> 1274=item B<perl-eval>: I<string>
1189 1275
1190Perl code to be evaluated when all extensions have been registered. See 1276Perl code to be evaluated when all extensions have been registered. See
1191the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1277the @@RXVT_NAME@@perl(3) manpage.
1192will be ignored when running setuid/setgid.
1193 1278
1194=item B<perl-lib>: I<path> 1279=item B<perl-lib>: I<path>
1195 1280
1196Colon-separated list of additional directories that hold extension 1281Colon-separated list of additional directories that hold extension
1197scripts. When looking for extensions specified by the C<perl> resource, 1282scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1198@@RXVT_NAME@@ will first look in these directories and then in 1283in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1199F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1284lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1200will be ignored when running setuid/setgid.
1201 1285
1202See the @@RXVT_NAME@@perl(3) manpage. 1286See the @@RXVT_NAME@@perl(3) manpage.
1203 1287
1204=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1288=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1205 1289
1209=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1293=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1210 1294
1211Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1295Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1212for details. 1296for details.
1213 1297
1214=item B<searchable-scrollback:> I<keysym> 1298=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1215 1299
1216Sets the hotkey that starts the incremental scrollback buffer search 1300This resource is deprecated and will be removed. Use a B<keysym> resource
1217(default: C<M-s>). 1301instead, e.g.:
1218 1302
1303 URxvt.keysym.M-s: searchable-scrollback:start
1304
1219=item B<urlLauncher>: I<string> 1305=item B<url-launcher>: I<string>
1220 1306
1221Specifies the program to be started with a URL argument. Used by the 1307Specifies the program to be started with a URL argument. Used by the
1222C<selection-popup> and C<matcher> perl extensions. 1308C<selection-popup> and C<matcher> perl extensions.
1223 1309
1224=item B<transient-for>: I<windowid> 1310=item B<transient-for>: I<windowid>
1228=item B<override-redirect>: I<boolean> 1314=item B<override-redirect>: I<boolean>
1229 1315
1230Compile I<frills>: Sets override-redirect for the terminal window, making 1316Compile I<frills>: Sets override-redirect for the terminal window, making
1231it almost invisible to window managers; option B<-override-redirect>. 1317it almost invisible to window managers; option B<-override-redirect>.
1232 1318
1319=item B<iso14755:> I<boolean>
1320
1321Turn on/off ISO 14755 (default enabled).
1322
1233=item B<iso14755_52:> I<boolean> 1323=item B<iso14755_52:> I<boolean>
1234 1324
1235Turn on/off ISO 14755 5.2 mode (default enabled). 1325Turn on/off ISO 14755 5.2 mode (default enabled).
1326
1327=back
1328
1329=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1330
1331=over 4
1332
1333=item B<-pixmap> I<file[;oplist]>
1334
1335=item B<backgroundPixmap:> I<file[;oplist]>
1336
1337Compile I<pixbuf>: Use the specified image file as the window's
1338background and also optionally specify a colon separated list of
1339operations to modify it. Note that you may need to quote the C<;>
1340character when using the command line option, as C<;> is usually a
1341metacharacter in shells. Supported operations are:
1342
1343=over 4
1344
1345=item B<WxH+X+Y>
1346
1347sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1348scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1349scale of 0 disables scaling.
1350
1351=item B<op=tile>
1352
1353enables tiling
1354
1355=item B<op=keep-aspect>
1356
1357maintain the image aspect ratio when scaling
1358
1359=item B<op=root-align>
1360
1361use the position of the terminal window relative to the root window as
1362the image offset, simulating a root window background
1363
1364=back
1365
1366The default scale and position setting is C<100x100+50+50>.
1367Alternatively, a predefined set of templates can be used to achieve
1368the most common setups:
1369
1370=over 4
1371
1372=item B<style=tiled>
1373
1374the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1375
1376=item B<style=aspect-stretched>
1377
1378the image is scaled to fill the whole window maintaining the aspect
1379ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1380
1381=item B<style=stretched>
1382
1383the image is scaled to fill the whole window. Equivalent to 100x100
1384
1385=item B<style=centered>
1386
1387the image is centered with no scaling. Equivalent to 0x0+50+50
1388
1389=item B<style=root-tiled>
1390
1391the image is tiled with no scaling and using 'root' positioning.
1392Equivalent to 0x0:op=tile:op=root-align
1393
1394=back
1395
1396If multiple templates are specified the last one wins. Note that a
1397template overrides all the scale, position and operations settings.
1398
1399If used in conjunction with pseudo-transparency, the specified pixmap
1400will be blended over the transparent background using alpha-blending.
1401
1402=item B<-tr>|B<+tr>
1403
1404=item B<transparent:> I<boolean>
1405
1406Turn on/off pseudo-transparency by using the root pixmap as background.
1407
1408B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1409will be removed in future versions.
1410
1411=item B<-tint> I<colour>
1412
1413=item B<tintColor:> I<colour>
1414
1415Tint the transparent background with the given colour. Note that a
1416black tint yields a completely black image while a white tint yields
1417the image unchanged.
1418
1419=item B<-sh> I<number>
1420
1421=item B<shading:> I<number>
1422
1423Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1424A value of 100 means no shading.
1425
1426=item B<-blr> I<HxV>
1427
1428=item B<blurRadius:> I<HxV>
1429
1430Apply gaussian blur with the specified radius to the transparent
1431background. If a single number is specified, the vertical and
1432horizontal radii are considered to be the same. Setting one of the
1433radii to 1 and the other to a large number creates interesting effects
1434on some backgrounds. The maximum radius value is 128. An horizontal or
1435vertical radius of 0 disables blurring.
1436
1437=item B<path:> I<path>
1438
1439Specify the colon-delimited search path for finding background image files.
1236 1440
1237=back 1441=back
1238 1442
1239=head1 THE SCROLLBAR 1443=head1 THE SCROLLBAR
1240 1444
1288window causes the value of the PRIMARY selection (or CLIPBOARD with the 1492window causes the value of the PRIMARY selection (or CLIPBOARD with the
1289B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1493B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1290 1494
1291Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1495Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1292inserted too. 1496inserted too.
1497
1498rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1499<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1500binding causes the value of the internal selection to be copied to the
1501CLIPBOARD selection, while the second binding causes the value of the
1502CLIPBOARD selection to be inserted.
1293 1503
1294=back 1504=back
1295 1505
1296=head1 CHANGING FONTS 1506=head1 CHANGING FONTS
1297 1507
1379B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1589B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1380it can be seen via the I<who(1)> command, and can accept messages. To 1590it can be seen via the I<who(1)> command, and can accept messages. To
1381allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1591allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1382on some systems or setgid to root or to some other group on others. 1592on some systems or setgid to root or to some other group on others.
1383 1593
1384=head1 COLORS AND GRAPHICS 1594=head1 COLOURS AND GRAPHICS
1385 1595
1386In addition to the default foreground and background colours, 1596In addition to the default foreground and background colours,
1387B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1597B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1388high-intensity bold/blink versions of the same). Here is a list of the 1598high-intensity (potentially bold/blink) versions of the same, and 72 (or
1389colours with their names. 1599240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1600cube plus a 8 (24) colour greyscale ramp.
1601
1602Here is a list of the ANSI colours with their names.
1390 1603
1391=begin table 1604=begin table
1392 1605
1393 B<color0> (black) = Black 1606 B<color0> (black) = Black
1394 B<color1> (red) = Red3 1607 B<color1> (red) = Red3
1414It is also possible to specify the colour values of B<foreground>, 1627It is also possible to specify the colour values of B<foreground>,
1415B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1628B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1416a number 0-15, as a convenient shorthand to reference the colour name of 1629a number 0-15, as a convenient shorthand to reference the colour name of
1417color0-color15. 1630color0-color15.
1418 1631
1419In addition to the colours defined above, @@RXVT_NAME@@ offers an 1632The following text gives values for the standard 88 colour mode (and
1420additional 72 colours. The first 64 of those (with indices 16 to 79) 1633values for the 256 colour mode in parentheses).
1421consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
142216>), followed by 8 additional shades of gray (with indices 80 to 87).
1423 1634
1635The RGB cube uses indices 16..79 (16..231) using the following formulas:
1636
1637 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1638 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1639
1640The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1641steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1642the RGB cube.
1643
1424Together, all those colours implement the 88 colour xterm colours. Only 1644Together, all those colours implement the 88 (256) colour xterm
1425the first 16 can be changed using resources currently, the rest can only 1645colours. Only the first 16 can be changed using resources currently, the
1426be changed via command sequences ("escape codes"). 1646rest can only be changed via command sequences ("escape codes").
1647
1648Applications are advised to use terminfo or command sequences to discover
1649number and RGB values of all colours (yes, you can query this...).
1427 1650
1428Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1651Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1429always swapping the foreground/background colours. This is in contrast to 1652always swapping the foreground/background colours. This is in contrast to
1430I<xterm>(1) where the colours are only swapped if they have not otherwise 1653I<xterm>(1) where the colours are only swapped if they have not otherwise
1431been specified. For example, 1654been specified. For example,
1432 1655
1433=over 4
1434
1435=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1656 @@RXVT_NAME@@ -fg Black -bg White -rv
1436 1657
1437would yield White on Black, while on I<xterm>(1) it would yield Black 1658would yield White on Black, while on I<xterm>(1) it would yield Black on
1438on White. 1659White.
1439
1440=back
1441 1660
1442=head2 ALPHA CHANNEL SUPPORT 1661=head2 ALPHA CHANNEL SUPPORT
1443 1662
1444If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1663If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1664their act together, rxvt-unicode will do its own alpha channel management:
1446(recommended, but B<MUST> have 4 digits/component) colour specifications, 1665
1447in addition to the ones provided by X, where the additional A component 1666You can prefix any colour with an opaqueness percentage enclosed in
1667brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1668(0-100) that specifies the opacity of the colour, where C<0> is completely
1669transparent and C<100> is completely opaque. For example, C<[50]red> is a
1670half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1671is the recommended format to specify transparency values, and works with
1672all ways to specify a colour.
1673
1674For complete control, rxvt-unicode also supports
1675C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1676specifications, where the additional C<aaaa> component specifies opacity
1448specifies opacity (alpha) values. The minimum value of C<0> is completely 1677(alpha) values. The minimum value of C<0000> is completely transparent,
1449transparent). You can also prefix any color with C<[percent]>, where 1678while C<ffff> is completely opaque). The two example colours from
1450C<percent> is a decimal percentage (0-100) that specifies the opacity of 1679earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1451the color, where C<0> is completely transparent and C<100> is completelxy 1680C<rgba:0000/ff00/0000/f332>.
1452opaque.
1453 1681
1454You probably need to specify B<"-depth 32">, too, and have the luck that 1682You probably need to specify B<"-depth 32">, too, to force a visual with
1455your X-server uses ARGB pixel layout, as X is far from just supporting 1683alpha channels, and have the luck that your X-server uses ARGB pixel
1456ARGB visuals out of the box, and rxvt-unicode just fudges around. 1684layout, as X is far from just supporting ARGB visuals out of the box, and
1685rxvt-unicode just fudges around.
1457 1686
1458For example, the following selects an almost completely transparent red 1687For example, the following selects an almost completely transparent black
1459background, and an almost opaque pink foreground: 1688background, and an almost opaque pink foreground:
1460 1689
1461 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1690 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1462 1691
1463I<Please note that transparency of any kind if completely unsupported by 1692When not using a background image, then the interpretation of the
1464the author. Don't bug him with installation questions!> 1693alpha channel is up to your compositing manager (most interpret it as
1694transparency of course).
1695
1696When using a background pixmap or pseudo-transparency, then the background
1697colour will always behave as if it were completely transparent (so the
1698background image shows instead), regardless of how it was specified, while
1699other colours will either be transparent as specified (the background
1700image will show through) on servers supporting the RENDER extension, or
1701fully opaque on servers not supporting the RENDER EXTENSION.
1702
1703Please note that due to bugs in Xft, specifying alpha values might result
1704in garbage being displayed when the X-server does not support the RENDER
1705extension.
1465 1706
1466=head1 ENVIRONMENT 1707=head1 ENVIRONMENT
1467 1708
1468B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1709B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1469 1710
1475resources or on the command line. 1716resources or on the command line.
1476 1717
1477=item B<COLORTERM> 1718=item B<COLORTERM>
1478 1719
1479Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1720Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480compiled with XPM support, and optionally with the added extension 1721compiled with background image support, and optionally with the added
1481C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1722extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1723screen.
1482 1724
1483=item B<COLORFGBG> 1725=item B<COLORFGBG>
1484 1726
1485Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1727Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486the colour code used as default foreground/text colour (or the string 1728the colour code used as default foreground/text colour (or the string
1487C<default> to indicate that the default-colour escape sequence is to be 1729C<default> to indicate that the default-colour escape sequence is to be
1488used), C<bg> is the colour code used as default background colour (or the 1730used), C<bg> is the colour code used as default background colour (or the
1489string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1731string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1732was compiled with background image support. Libraries like C<ncurses>
1491(and do) use this information to optimize screen output. 1733and C<slang> can (and do) use this information to optimize screen output.
1492 1734
1493=item B<WINDOWID> 1735=item B<WINDOWID>
1494 1736
1495Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1737Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1496window, which usually has subwindows for the scrollbar, the terminal 1738window, which usually has subwindows for the scrollbar, the terminal
1502C<--with-terminfo=PATH>. 1744C<--with-terminfo=PATH>.
1503 1745
1504=item B<DISPLAY> 1746=item B<DISPLAY>
1505 1747
1506Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1748Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1507display in its child processes. 1749display in its child processes if C<-display> isn't used to override. It
1750defaults to C<:0> if it doesn't exist.
1508 1751
1509=item B<SHELL> 1752=item B<SHELL>
1510 1753
1511The shell to be used for command execution, defaults to C</bin/sh>. 1754The shell to be used for command execution, defaults to C</bin/sh>.
1512 1755
1513=item B<RXVT_SOCKET> 1756=item B<RXVT_SOCKET> [I<sic>]
1514 1757
1515The unix domain socket path used by @@RXVT_NAME@@c(1) and 1758The unix domain socket path used by @@RXVT_NAME@@c(1) and
1516@@RXVT_NAME@@d(1). 1759@@RXVT_NAME@@d(1).
1517 1760
1518Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1761Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1762
1763=item B<URXVT_PERL_LIB>
1764
1765Additional F<:>-separated library search path for perl extensions. Will be
1766searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1767directory.
1768
1769=item B<URXVT_PERL_VERBOSITY>
1770
1771See L<@@RXVT_NAME@@perl>(3).
1519 1772
1520=item B<HOME> 1773=item B<HOME>
1521 1774
1522Used to locate the default directory for the unix domain socket for 1775Used to locate the default directory for the unix domain socket for
1523daemon communications and to locate various resource files (such as 1776daemon communications and to locate various resource files (such as
1524C<.Xdefaults>) 1777C<.Xdefaults>)
1525 1778
1526=item B<XAPPLRESDIR> 1779=item B<XAPPLRESDIR>
1527 1780
1528Directory where various X resource files are being located. 1781Directory where application-specific X resource files are located.
1529 1782
1530=item B<XENVIRONMENT> 1783=item B<XENVIRONMENT>
1531 1784
1532If set and accessible, gives the name of a X resource file to be loaded by 1785If set and accessible, gives the name of a X resource file to be loaded by
1533@@RXVT_NAME@@. 1786@@RXVT_NAME@@.
1538 1791
1539=over 4 1792=over 4
1540 1793
1541=item B</usr/lib/X11/rgb.txt> 1794=item B</usr/lib/X11/rgb.txt>
1542 1795
1543Color names. 1796Colour names.
1544 1797
1545=back 1798=back
1546 1799
1547=head1 SEE ALSO 1800=head1 SEE ALSO
1548 1801
1802@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1549@@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) 1803@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1550 1804
1551=head1 CURRENT PROJECT COORDINATOR 1805=head1 CURRENT PROJECT COORDINATOR
1552 1806
1553=over 4 1807=over 4
1554 1808
1555=item Project Coordinator 1809=item Project Coordinator
1556 1810
1557Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1811Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1558 1812
1559L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1813L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1560 1814
1561=back 1815=back
1562 1816
1566 1820
1567=item John Bovey 1821=item John Bovey
1568 1822
1569University of Kent, 1992, wrote the original Xvt. 1823University of Kent, 1992, wrote the original Xvt.
1570 1824
1571=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1825=item Rob Nation <nation@rocket.sanders.lockheed.com>
1572 1826
1573very heavily modified Xvt and came up with Rxvt 1827very heavily modified Xvt and came up with Rxvt
1574 1828
1575=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1829=item Angelo Haritsis <ah@doc.ic.ac.uk>
1576 1830
1577wrote the Greek Keyboard Input (no longer in code) 1831wrote the Greek Keyboard Input (no longer in code)
1578 1832
1579=item mj olesen L<< <olesen@me.QueensU.CA> >> 1833=item mj olesen <olesen@me.QueensU.CA>
1580 1834
1581Wrote the menu system. 1835Wrote the menu system.
1582 1836
1583Project Coordinator (changes.txt 2.11 to 2.21) 1837Project Coordinator (changes.txt 2.11 to 2.21)
1584 1838
1585=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1839=item Oezguer Kesim <kesim@math.fu-berlin.de>
1586 1840
1587Project Coordinator (changes.txt 2.21a to 2.4.5) 1841Project Coordinator (changes.txt 2.21a to 2.4.5)
1588 1842
1589=item Geoff Wing L<< <gcw@pobox.com> >> 1843=item Geoff Wing <gcw@pobox.com>
1590 1844
1591Rewrote screen display and text selection routines. 1845Rewrote screen display and text selection routines.
1592 1846
1593Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1847Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594 1848
1595=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1849=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1596 1850
1597Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1851Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1598extension, random hacks, numerous bugfixes and extensions. 1852extension, random hacks, numerous bugfixes and extensions.
1599 1853
1600Project Coordinator (Changes 1.0 -) 1854Project Coordinator (Changes 1.0 -)
1601 1855
1602=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1856=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1603 1857
1604Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1858pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1605 1859
1606=back 1860=back
1607 1861

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines