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.120 by root, Sat Aug 12 01:37:11 2006 UTC vs.
Revision 1.249 by root, Sat Oct 10 20:03:39 2020 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are 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>
108 122
109Turn on/off simulated reverse video; resource B<reverseVideo>. 123Turn on/off simulated reverse video; resource B<reverseVideo>.
110 124
111=item B<-j>|B<+j> 125=item B<-j>|B<+j>
112 126
113Turn on/off jump scrolling; resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 128
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 129=item B<-ss>|B<+ss>
116 130
117Turn on/off inheriting parent window's pixmap. Alternative form is 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
123 132
124=item B<-fade> I<number> 133=item B<-fade> I<number>
125 134
126Fade 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
127fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
130=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
131 140
132Fade 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
133is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
134 143
135=item B<-tint> I<colour> 144=item B<-icon> I<file>
136 145
137Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
138transparency is enabled with B<-tr> or B<-ip>. This only works for 147is used by many window managers, taskbars and pagers to represent the
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application window; resource I<iconFile>.
140used to brighten or darken the image in addition to tinting it; resource
141I<tintColor>. Example:
142
143 @@RXVT_NAME@@ -tr -tint blue -sh 40
144
145=item B<-sh>
146
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be
149specified, too, e.g. C<-tint white>).
150 149
151=item B<-bg> I<colour> 150=item B<-bg> I<colour>
152 151
153Window background colour; resource B<background>. 152Window background colour; resource B<background>.
154 153
155=item B<-fg> I<colour> 154=item B<-fg> I<colour>
156 155
157Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
158
159=item B<-pixmap> I<file[;geom]>
160
161Compile I<XPM>: Specify XPM file for the background and also optionally
162specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>.
165 157
166=item B<-cr> I<colour> 158=item B<-cr> I<colour>
167 159
168The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
169 161
214italic> >> characters are to be printed. See resource B<boldItalicFont> 206italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 207for details.
216 208
217=item B<-is>|B<+is> 209=item B<-is>|B<+is>
218 210
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 211Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 212foreground/background (default). See resource B<intensityStyles> for
221details. 213details.
222 214
223=item B<-name> I<name> 215=item B<-name> I<name>
224 216
228 220
229=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
230 222
231Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
232 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
233=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
234 230
235Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
236B<utmpInhibit>. 232B<utmpInhibit>.
237 233
241B<visualBell>. 237B<visualBell>.
242 238
243=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
244 240
245Turn 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>.
246 251
247=item B<-si>|B<+si> 252=item B<-si>|B<+si>
248 253
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
257=item B<-sw>|B<+sw> 262=item B<-sw>|B<+sw>
258 263
259Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 266B<scrollWithBuffer>.
262
263=item B<-sr>|B<+sr>
264
265Put scrollbar on right/left; resource B<scrollBar_right>.
266
267=item B<-st>|B<+st>
268
269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270resource B<scrollBar_floating>.
271 267
272=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
273 269
274If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 271actual wide characters in the screen buffer, which makes it possible to
279 275
280=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
281 277
282Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
283 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
284=item B<-iconic> 284=item B<-iconic>
285 285
286Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
287Alternative form is B<-ic>. 287Alternative form is B<-ic>.
288 288
304 304
305=item B<-bl> 305=item B<-bl>
306 306
307Compile 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.
308if 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
309decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
310 311
311=item B<-override-redirect> 312=item B<-override-redirect>
312 313
313Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
314B<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.
315 321
316=item B<-sbg> 322=item B<-sbg>
317 323
318Compile 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
319drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
322 328
323=item B<-lsp> I<number> 329=item B<-lsp> I<number>
324 330
325Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
327B<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>.
328 341
329=item B<-tn> I<termname> 342=item B<-tn> I<termname>
330 343
331This 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
332B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
367=item B<-pt> I<style> 380=item B<-pt> I<style>
368 381
369Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
370B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
371 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
372=item B<-im> I<text> 388=item B<-im> I<text>
373 389
374Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
375 391
376=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
386for more info. 402for more info.
387 403
388=item B<-tcw> 404=item B<-tcw>
389 405
390Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
407button. Only effective when the original (non-perl) selection code is
391button. 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
392end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
393 410
394=item B<-insecure> 411=item B<-insecure>
395 412
396Enable "insecure" mode, which currently enables most of the escape 413Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 414sequences that echo strings. See the resource B<insecure> for more
417 434
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 436will not immediately destroy its window when the program executed within
420it 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
421user; 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.
422 458
423=item B<-keysym.>I<sym> I<string> 459=item B<-keysym.>I<sym> I<string>
424 460
425Remap a key symbol. See resource B<keysym>. 461Remap a key symbol. See resource B<keysym>.
426 462
461If 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
462entries 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
463yourself if you want that. 499yourself if you want that.
464 500
465As an extremely special case, specifying C<-1> will completely suppress 501As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 502pty/tty operations, which is probably only useful in conjunction with some
503perl extension that manages the terminal.
467 504
468Here 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
469longer example is in F<doc/pty-fd>): 506longer example is in F<doc/pty-fd>):
470 507
471 use IO::Pty; 508 use IO::Pty;
485Comma-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
486this terminal instance. See resource B<perl-ext> for details. 523this terminal instance. See resource B<perl-ext> for details.
487 524
488=back 525=back
489 526
490=head1 RESOURCES (available also as long-options) 527=head1 RESOURCES
491 528
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 529Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 530options) compiled into your version. All resources are also available as
531long-options.
494 532
495You 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
496distribution do also load settings from the B<~/.Xresources> file when X 534distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 536with later settings overwriting earlier ones:
499 537
500 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 538 1. app-defaults file in $XAPPLRESDIR
539 2. $HOME/.Xdefaults
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 540 3. RESOURCE_MANAGER property on root-window of screen 0
503 4. SCREEN_RESOURCES for the current screen 541 4. SCREEN_RESOURCES property on root-window of the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
543 6. resources specified via -xrm on the commandline
505 544
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: 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
508common 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
509configured, while the class name B<URxvt> allows resources unique to 548configured, while the class name B<URxvt> allows resources unique to
519=item B<depth:> I<bitdepth> 558=item B<depth:> I<bitdepth>
520 559
521Compile 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;
522option B<-depth>. 561option B<-depth>.
523 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
524=item B<geometry:> I<geom> 570=item B<geometry:> I<geom>
525 571
526Create the window with the specified X window geometry [default 80x24]; 572Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 573option B<-geometry>.
528 574
541Use 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
542corresponds to low-intensity (normal) colours and 8-15 corresponds to 588corresponds to low-intensity (normal) colours and 8-15 corresponds to
543high-intensity (bold = bright foreground, blink = bright background) 589high-intensity (bold = bright foreground, blink = bright background)
544colours. 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,
5453=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
546names used are listed in the B<COLORS AND GRAPHICS> section. 592names used are listed in the B<COLOURS AND GRAPHICS> section.
547 593
548Colours 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
549changed using an escape command (see @@RXVT_NAME@@(7)). 595changed using an escape command (see @@RXVT_NAME@@(7)).
550 596
551Colours 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
562=item B<colorUL:> I<colour> 608=item B<colorUL:> I<colour>
563 609
564Use the specified colour to display underlined characters when the 610Use the specified colour to display underlined characters when the
565foreground colour is the default. 611foreground colour is the default.
566 612
567=item B<colorRV:> I<colour>
568
569Use the specified colour as the background for reverse video
570characters.
571
572=item B<underlineColor:> I<colour> 613=item B<underlineColor:> I<colour>
573 614
574If set, use the specified colour as the colour for the underline 615If set, use the specified colour as the colour for the underline
575itself. 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.
576 627
577=item B<cursorColor:> I<colour> 628=item B<cursorColor:> I<colour>
578 629
579Use 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
580foreground colour; option B<-cr>. 631foreground colour; option B<-cr>.
587 638
588=item B<reverseVideo:> I<boolean> 639=item B<reverseVideo:> I<boolean>
589 640
590B<True>: simulate reverse video by foreground and background colours; 641B<True>: simulate reverse video by foreground and background colours;
591option B<-rv>. B<False>: regular screen colours [default]; option 642option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 643B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593 644
594=item B<jumpScroll:> I<boolean> 645=item B<jumpScroll:> I<boolean>
595 646
596B<True>: specify that jump scrolling should be used. When scrolling 647B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 648of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
649has been read, resulting in fewer updates while still displaying every
650received line; option B<-j>.
651
598B<False>: specify that smooth scrolling should be used; option B<+j>. 652B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
653force a screen refresh on each new line it received; option B<+j>.
599 654
600=item B<inheritPixmap:> I<boolean> 655=item B<skipScroll:> I<boolean>
601 656
602B<True>: make the background inherit the parent windows' pixmap, giving 657B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 658receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 659(around 60 times per second), resulting in far fewer updates. This can
660result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
661option B<-ss>.
605 662
606I<Please note that transparency of any kind if completely unsupported by 663B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 664if the refresh is too fast for the human eye to read anything (or the
665monitor to display anything); option B<+ss>.
608 666
609=item B<fading:> I<number> 667=item B<fading:> I<number>
610 668
611Fade 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>.
612 670
613=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
614 672
615Fade 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
616colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
617 675
618=item B<tintColor:> I<colour> 676=item B<iconFile:> I<file>
619 677
620Tint the transparent background pixmap with the given colour; option 678Set the application icon pixmap; option B<-icon>.
621B<-tint>.
622
623=item B<shading:> I<number>
624
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
626image in addition to tinting it.
627 679
628=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
629 681
630Use the specified colour for the scrollbar [default #B2B2B2]. 682Use the specified colour for the scrollbar [default #B2B2B2].
631 683
636 688
637=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
638 690
639The 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
640and the text. 692and the text.
641
642=item B<backgroundPixmap:> I<file[;geom]>
643
644Use the specified XPM file (note the `.xpm' extension is optional) for
645the background and also optionally specify its scaling with a geometry
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale
649of 1 displays the image without any scaling. A scale of 2 to 9
650specifies an integer number of images in that direction. No image will
651be magnified beyond 10 times its original size. The maximum permitted
652scale is 1000. [default 0x0+50+50]
653
654=item B<path:> I<path>
655
656Specify the colon-delimited search path for finding XPM files.
657 693
658=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
659 695
660Select 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
661that 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
684it 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
685wide and 15 pixels high. 721wide and 15 pixels high.
686 722
687The 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
688the base font, likewise the third, which is unfortunately non-bold, but 724the base font, likewise the third, which is unfortunately non-bold, but
689the 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
690useful supplement. 726useful supplement.
691 727
692The 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
693are 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
694contains other characters, but we are not interested in them. 730contains other characters, but we are not interested in them.
718text font will being used for the given style. 754text font will being used for the given style.
719 755
720=item B<intensityStyles:> I<boolean> 756=item B<intensityStyles:> I<boolean>
721 757
722When 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>,
723option B<-is>, the default), bold and italic font styles imply high 759option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 760intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 761option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 762reachable.
727 763
728=item B<selectstyle:> I<mode>
729
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731xterm style with 2.20 old word selection, or anything else which gives
732xterm style selection.
733
734=item B<scrollstyle:> I<mode>
735
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite.
738
739=item B<title:> I<string> 764=item B<title:> I<string>
740 765
741Set window title string, the default title is the command-line 766Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 767specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 768name; option B<-title>.
751=item B<mapAlert:> I<boolean> 776=item B<mapAlert:> I<boolean>
752 777
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 778B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 779de-iconify (map) on receipt of a bell character [default].
755 780
781=item B<urgentOnBell:> I<boolean>
782
783B<True>: set the urgency hint for the wm on receipt of a bell character.
784B<False>: do not set the urgency hint [default].
785
786@@RXVT_NAME@@ resets the urgency hint on every focus change.
787
756=item B<visualBell:> I<boolean> 788=item B<visualBell:> I<boolean>
757 789
758B<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>.
759B<False>: no visual bell [default]; option B<+vb>. 791B<False>: no visual bell [default]; option B<+vb>.
760 792
762 794
763B<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
764the 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
765[default]; option B<+ls>. 797[default]; option B<+ls>.
766 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
767=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
768 805
769B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
770option 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>
771[default]; option B<+ut>. 808[default]; option B<+ut>.
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 820 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 821
785This 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
786every time you hit C<Print>. 823every time you hit C<Print>.
787 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
788=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
789 835
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
792 838
811B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
812B<+si>. 858B<+si>.
813 859
814=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
815 861
816B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
818with 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>.
819 866
820=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
821 868
822B<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
823are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
824are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 871are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
825bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
826 873
827=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
828 875
829Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
830resource is limited on most machines to 65535; option B<-sl>.
831 877
832=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
833 879
834Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
835option B<-b>. 881option B<-b>.
854=item B<termName:> I<termname> 900=item B<termName:> I<termname>
855 901
856Specifies the terminal type name to be set in the B<TERM> environment 902Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 903variable; option B<-tn>.
858 904
859=item B<linespace:> I<number> 905=item B<lineSpace:> I<number>
860 906
861Specifies number of lines (pixel height) to insert between each row of 907Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 908the display [default 0]; option B<-lsp>.
863 909
864=item B<meta8:> I<boolean> 910=item B<meta8:> I<boolean>
878 924
879=item B<cursorBlink:> I<boolean> 925=item B<cursorBlink:> I<boolean>
880 926
881B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 927B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882option B<-bc>. 928option B<-bc>.
929
930=item B<cursorUnderline:> I<boolean>
931
932B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
933option B<-uc>.
883 934
884=item B<pointerBlank:> I<boolean> 935=item B<pointerBlank:> I<boolean>
885 936
886B<True>: blank the pointer when a key is pressed or after a set number 937B<True>: blank the pointer when a key is pressed or after a set number
887of seconds of inactivity. B<False>: the pointer is always visible 938of seconds of inactivity. B<False>: the pointer is always visible
893 944
894=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
895 946
896Mouse pointer background colour. 947Mouse pointer background colour.
897 948
949=item B<pointerShape:> I<string>
950
951Compile I<frills>: Specifies the name of the mouse pointer shape
952[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
953file for possible values (omit the C<XC_> prefix).
954
898=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
899 956
900Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
901large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
902 959
903=item B<backspacekey:> I<string> 960=item B<backspacekey:> I<string>
904 961
905The string to send when the backspace key is pressed. If set to B<DEC> 962The string to send when the backspace key is pressed. If set to B<DEC>
906or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 963or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
907(code 8) - which can be reversed with the appropriate DEC private mode 964(code 8) - which can be reversed with the appropriate DEC private mode
908escape sequence. 965escape sequence.
909 966
910=item B<deletekey:> I<string> 967=item B<deletekey:> I<string>
911 968
916=item B<cutchars:> I<string> 973=item B<cutchars:> I<string>
917 974
918The characters used as delimiters for double-click word selection 975The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 976(whitespace delimiting is added automatically if resource is given).
920 977
921When the selection extension is in use (the default if compiled in, see 978When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 979in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 980characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 981will be created). In this mode, characters outside ISO-8859-1 can be used.
925 982
926When the selection extension is not used, only ISO-8859-1 characters can 983When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 984be used. If not specified, the built-in default is used:
928 985
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 987
931=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
932 989
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 991
935=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
936 993
937I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
938 995
988 1045
989Turn on/off secondary screen (default enabled). 1046Turn on/off secondary screen (default enabled).
990 1047
991=item B<secondaryScroll:> I<boolean> 1048=item B<secondaryScroll:> I<boolean>
992 1049
993Turn on/off secondary screen scroll (default enabled). If the this 1050Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1051option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1052scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1053to/from the secondary screen will instead scroll the screen up.
997 1054
998=item B<hold>: I<boolean> 1055=item B<hold>: I<boolean>
999 1056
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1057Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1058will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the 1059it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1060user.
1004 1061
1062=item B<chdir>: I<path>
1063
1064Sets the working directory for the shell (or the command specified via
1065B<-e>). The I<path> must be an absolute path and it must exist for
1066@@RXVT_NAME@@ to start. If it isn't specified then the current working
1067directory will be used; option B<-cd>.
1068
1005=item B<keysym.>I<sym>: I<string> 1069=item B<keysym.>I<sym>: I<action>
1006 1070
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1071Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1008intervening resource name B<keysym.> cannot be omitted. 1072resource name B<keysym.> cannot be omitted.
1009 1073
1010The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1074Using this resource, you can map key combinations such as
1011any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1075C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1012B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1076string than would normally result from that combination, making the
1013and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1077terminal scroll up or down the way you want it, or any other thing an
1014B<2>, B<3>, B<4>, B<5>. 1078extension might provide.
1079
1080The key combination that triggers the action, I<sym>, has the following format:
1081
1082 (modifiers-)key
1083
1084Where I<modifiers> can be any combination of the following full or
1085abbreviated modifier names:
1086
1087=begin table
1088
1089 B<ISOLevel3> B<I>
1090 B<AppKeypad> B<K>
1091 B<Control> B<C>
1092 B<NumLock> B<N>
1093 B<Shift> B<S>
1094 B<Meta> B<M>, B<A>
1095 B<Lock> B<L>
1096 B<Mod1> B<1>
1097 B<Mod2> B<2>
1098 B<Mod3> B<3>
1099 B<Mod4> B<4>
1100 B<Mod5> B<5>
1101
1102=end table
1015 1103
1016The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1104The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1017whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1105whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1018keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1106keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1019current application keymap mode state. 1107current application keymap mode state.
1020 1108
1021The spellings of I<key> can be obtained by using B<xev>(1) command or 1109Due the the large number of modifier combinations, a key mapping will
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1110match if I<at least> the specified identifiers are being set, and no other
1111key mappings with those and more bits are being defined. That means that
1112defining a mapping for C<a> will automatically provide definitions for
1113C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1114themselves. See the C<builtin:> action, below, for a way to work around
1115this when this is a problem.
1116
1117The spelling of I<key> depends on your implementation of X. An easy way to
1118find a key name is to use the B<xev>(1) command. You can find a list by
1119looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1023omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1120the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1024keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1121value (B<0x0000 - 0xFFFF>).
1025performed in an exact manner; however, the closest match is assured.
1026 1122
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1123As with any resource value, the I<action> string may contain backslash
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1124escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1125number), see RESOURCES in C<man 7 X> for further details.
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace. B<This feature is deprecated and will
1032be removed>.
1033 1126
1034Please note that you need to double the C<\> in resource files, as 1127An action starts with an action prefix that selects a certain type
1035Xlib itself does its own de-escaping (you can use C<\033> instead of 1128of action, followed by a colon. An action string without colons is
1036C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1129interpreted as a literal string to pass to the tty (as if it was
1037processing). 1130prefixed with C<string:>).
1038 1131
1039You can define a range of keysyms in one shot by providing a I<string> 1132The following action prefixes are known - extensions can provide
1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1133additional prefixes:
1134
1135=over 4
1136
1137=item string:STRING
1138
1139If the I<action> starts with C<string:> (or otherwise contains no colons),
1140then the remaining C<STRING> will be passed to the program running in the
1141terminal. For example, you could replace whatever Shift-Tab outputs by the
1142string C<echo rm -rf /> followed by a newline:
1143
1144 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1145
1146This could in theory be used to completely redefine your keymap.
1147
1148In addition, for actions of this type, you can define a range of
1149keysyms in one shot by loading the C<keysym-list> perl extension and
1150providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1041should be a character not used by the strings. 1151the delimiter `/' should be a character not used by the strings.
1042 1152
1043Its usage can be demonstrated by an example: 1153Its usage can be demonstrated by an example:
1044 1154
1045 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1155 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1046 1156
1047The above line is equivalent to the following three lines: 1157The above line is equivalent to the following three lines:
1048 1158
1049 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1159 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1050 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1160 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1051 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1161 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1052 1162
1163=item command:STRING
1164
1053If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1165If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1054is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1166is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1167the opposite of C<string:> - instead of sending it to the program running
1168in the terminal, it will be treated as if it were program output). This is
1169most useful to feed command sequences into @@RXVT_NAME@@.
1170
1055example the following means "change the current locale to C<zh_CN.GBK> 1171For example the following means "change the current locale to C<zh_CN.GBK>
1056when Control-Meta-c is being pressed": 1172when Control-Meta-c is being pressed":
1057 1173
1058 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1059 1175
1060If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1176The following example will map Control-Meta-1 and Control-Meta-2 to
1061is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1062manpage. For example, the F<selection> extension (activated via 1178font-switching at runtime:
1063C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1064 1179
1065 URxvt.keysym.M-C-c: perl:selection:rot13 1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1181 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1066 1182
1067Due the the large number of modifier combinations, a defined key mapping 1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1068will match if at I<at least> the specified identifiers are being set, and 1184info):
1069no other key mappings with those and more bits are being defined. That
1070means that defining a key map for C<a> will automatically provide
1071definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1072mappings themselves.
1073 1185
1074Unfortunately, this will override built-in key mappings. For example 1186 URxvt.keysym.M-C-3: command:\033[8;25;80t
1187 URxvt.keysym.M-C-4: command:\033[8;48;110t
1188
1189=item builtin:
1190
1191The builtin action is the action that @@RXVT_NAME@@ would execute if no
1192key binding existed for the key combination. The obvious use is to undo
1193the effect of existing bindings. The not so obvious use is to reinstate
1194bindings when another binding overrides too many modifiers.
1195
1075if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1196For example if you overwrite the C<Insert> key you will disable
1076C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1197@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1077user-defined keymap using the C<builtin:> replacement: 1198"holes" into the user-defined keymap using the C<builtin:> replacement:
1078 1199
1079 URxvt.keysym.Insert: <my insert key sequence> 1200 URxvt.keysym.Insert: <my insert key sequence>
1080 URxvt.keysym.S-Insert: builtin: 1201 URxvt.keysym.S-Insert: builtin:
1081 1202
1082The first line defines a mapping for C<Insert> and I<any> combination 1203The first line defines a mapping for C<Insert> and I<any> combination
1083of modifiers. The second line re-establishes the default mapping for 1204of modifiers. The second line re-establishes the default mapping for
1084C<Shift-Insert>. 1205C<Shift-Insert>.
1085 1206
1086The following example will map Control-Meta-1 and Control-Meta-2 to 1207=item builtin-string:
1087the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1088font-switching at runtime:
1089 1208
1090 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1209This action is mainly useful to restore string mappings for keys that
1091 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1210have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1211difficult to explain - basically, this action will send the string to the
1212application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1213action for it.
1092 1214
1093Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1215An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1094info): 1216selection when you press C<Shift-Insert>. With the following bindings, it
1217would instead emit the (undocumented, but what applications running in the
1218terminal might expect) sequence C<ESC [ 2 $> instead:
1095 1219
1096 URxvt.keysym.M-C-3: command:\033[8;25;80t 1220 URxvt.keysym.S-Insert: builtin-string:
1097 URxvt.keysym.M-C-4: command:\033[8;48;110t 1221 URxvt.keysym.C-S-Insert: builtin:
1222
1223The first line disables the paste functionality for that key
1224combination, and the second reinstates the default behaviour for
1225C<Control-Shift-Insert>, which would otherwise be overridden.
1226
1227Similarly, to let applications gain access to the C<C-M-c> (copy to
1228clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1229this:
1230
1231 URxvt.keysym.C-M-c: builtin-string:
1232 URxvt.keysym.C-M-v: builtin-string:
1233
1234=item EXTENSION:STRING
1235
1236An action of this form invokes the action B<STRING>, if any, provided
1237by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1238be loaded automatically if necessary.
1239
1240Not all extensions define actions, but popular extensions that do
1241include the I<selection> and I<matcher> extensions (documented in their
1242own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1243respectively).
1244
1245From the silly examples department, this will rot13-"encrypt"
1246@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1247keyboards:
1248
1249 URxvt.keysym.M-C-c: selection:rot13
1250
1251=item perl:STRING *DEPRECATED*
1252
1253This is a deprecated way of invoking commands provided by perl
1254extensions. It is still supported, but should not be used anymore.
1255
1256=back
1098 1257
1099=item B<perl-ext-common>: I<string> 1258=item B<perl-ext-common>: I<string>
1100 1259
1101=item B<perl-ext>: I<string> 1260=item B<perl-ext>: I<string>
1102 1261
1104use in this terminal instance; option B<-pe>. 1263use in this terminal instance; option B<-pe>.
1105 1264
1106Extension names can be prefixed with a C<-> sign to prohibit using 1265Extension names can be prefixed with a C<-> sign to prohibit using
1107them. This can be useful to selectively disable some extensions loaded 1266them. This can be useful to selectively disable some extensions loaded
1108by default, or specified via the C<perl-ext-common> resource. For 1267by default, or specified via the C<perl-ext-common> resource. For
1109example, C<default,-selection> will use all the default extension except 1268example, C<default,-selection> will use all the default extensions except
1110C<selection>. 1269C<selection>.
1111 1270
1112Extension names can also be followed by an argument in angle brackets 1271The default set includes the C<selection>, C<option-popup>,
1113(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1272C<selection-popup>, C<readline> and C<searchable-scrollback>
1114searchable scrollback to Alt/Meta-s). Mentioning the same extension 1273extensions, and extensions which are mentioned in B<keysym> resources.
1115multiple times with different arguments will pass multiple arguments to 1274
1116the extension. 1275Any extension such that a corresponding resource is given on the
1276command line is automatically appended to B<perl-ext>.
1117 1277
1118Each extension is looked up in the library directories, loaded if 1278Each extension is looked up in the library directories, loaded if
1119necessary, and bound to the current terminal instance. 1279necessary, and bound to the current terminal instance. When the library
1280search path contains multiple extension files of the same name, then the
1281first one found will be used.
1120 1282
1121If both of these resources are the empty string, then the perl 1283If both of these resources are the empty string, then the perl interpreter
1122interpreter will not be initialized. The idea behind two options is that 1284will not be initialized. The rationale for having two options is that
1123B<perl-ext-common> will be used for extensions that should be available to 1285B<perl-ext-common> will be used for extensions that should be available to
1124all instances, while B<perl-ext> is used for specific instances. 1286all instances, while B<perl-ext> is used for specific instances.
1125 1287
1126=item B<perl-eval>: I<string> 1288=item B<perl-eval>: I<string>
1127 1289
1128Perl code to be evaluated when all extensions have been registered. See 1290Perl code to be evaluated when all extensions have been registered. See
1129the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1291the @@RXVT_NAME@@perl(3) manpage.
1130will be ignored when running setuid/setgid.
1131 1292
1132=item B<perl-lib>: I<path> 1293=item B<perl-lib>: I<path>
1133 1294
1134Colon-separated list of additional directories that hold extension 1295Colon-separated list of additional directories that hold extension
1135scripts. When looking for extensions specified by the C<perl> resource, 1296scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1136@@RXVT_NAME@@ will first look in these directories and then in 1297in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1137F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1298lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1138will be ignored when running setuid/setgid.
1139 1299
1140See the @@RXVT_NAME@@perl(3) manpage. 1300See the @@RXVT_NAME@@perl(3) manpage.
1141 1301
1142=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1302=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1143 1303
1147=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1307=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1148 1308
1149Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1309Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1150for details. 1310for details.
1151 1311
1152=item B<searchable-scrollback:> I<keysym> 1312=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1153 1313
1154Sets the hotkey that starts the incremental scrollback buffer search 1314This resource is deprecated and will be removed. Use a B<keysym> resource
1155(default: C<M-s>). 1315instead, e.g.:
1156 1316
1317 URxvt.keysym.M-s: searchable-scrollback:start
1318
1157=item B<urlLauncher>: I<string> 1319=item B<url-launcher>: I<string>
1158 1320
1159Specifies the program to be started with a URL argument. Used by the 1321Specifies the program to be started with a URL argument. Used by the
1160C<selection-popup> and C<mark-urls> perl extensions. 1322C<selection-popup> and C<matcher> perl extensions.
1161 1323
1162=item B<transient-for>: I<windowid> 1324=item B<transient-for>: I<windowid>
1163 1325
1164Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1326Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1165 1327
1166=item B<override-redirect>: I<boolean> 1328=item B<override-redirect>: I<boolean>
1167 1329
1168Compile I<frills>: Sets override-redirect for the terminal window, making 1330Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>. 1331it almost invisible to window managers; option B<-override-redirect>.
1332
1333=item B<iso14755:> I<boolean>
1334
1335Turn on/off ISO 14755 (default enabled).
1336
1337=item B<iso14755_52:> I<boolean>
1338
1339Turn on/off ISO 14755 5.2 mode (default enabled).
1170 1340
1171=back 1341=back
1172 1342
1173=head1 THE SCROLLBAR 1343=head1 THE SCROLLBAR
1174 1344
1193application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1363application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1364(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1365up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196respectively. 1366respectively.
1197 1367
1198=head1 TEXT SELECTION AND INSERTION 1368=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199 1369
1200The behaviour of text selection and insertion mechanism is similar to 1370The behaviour of text selection and insertion/pasting mechanism is similar
1201I<xterm>(1). 1371to I<xterm>(1).
1202 1372
1203=over 4 1373=over 4
1204 1374
1205=item B<Selection>: 1375=item B<Selecting>:
1206 1376
1207Left click at the beginning of the region, drag to the end of the region 1377Left click at the beginning of the region, drag to the end of the region
1208and release; Right click to extend the marked region; Left double-click 1378and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1379to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1380(which can span multiple screen lines), unless modified by resource
1214(Compile: I<frills>) will create a rectangular selection instead of a 1384(Compile: I<frills>) will create a rectangular selection instead of a
1215normal one. In this mode, every selected row becomes its own line in the 1385normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1386selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1387the selection.
1218 1388
1219=item B<Insertion>: 1389=item B<Pasting>:
1220 1390
1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1391Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222window causes the value of the PRIMARY selection (or CLIPBOARD with the 1392window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223Meta modifier) to be inserted as if it had been typed on the keyboard. 1393B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224 1394
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1395Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too. 1396inserted too.
1227 1397
1398rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1399<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1400binding causes the value of the internal selection to be copied to the
1401CLIPBOARD selection, while the second binding causes the value of the
1402CLIPBOARD selection to be inserted.
1403
1228=back 1404=back
1229 1405
1230=head1 CHANGING FONTS 1406=head1 CHANGING FONTS
1231 1407
1232Changing fonts (or font sizes, respectively) via the keypad is not yet 1408Changing fonts (or font sizes, respectively) via the keypad is not yet
1245 1421
1246=head1 ISO 14755 SUPPORT 1422=head1 ISO 14755 SUPPORT
1247 1423
1248ISO 14755 is a standard for entering and viewing unicode characters 1424ISO 14755 is a standard for entering and viewing unicode characters
1249and character codes using the keyboard. It consists of 4 parts. The 1425and character codes using the keyboard. It consists of 4 parts. The
1250first part is available rxvt-unicode has been compiled with 1426first part is available if rxvt-unicode has been compiled with
1251C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1427C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1252with C<--enable-iso14755>. 1428with C<--enable-iso14755>.
1253 1429
1254=over 4 1430=over 4
1255 1431
1313B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1489B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1314it can be seen via the I<who(1)> command, and can accept messages. To 1490it can be seen via the I<who(1)> command, and can accept messages. To
1315allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1491allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1316on some systems or setgid to root or to some other group on others. 1492on some systems or setgid to root or to some other group on others.
1317 1493
1318=head1 COLORS AND GRAPHICS 1494=head1 COLOURS AND GRAPHICS
1319 1495
1320In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1321B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1497B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1322high-intensity bold/blink versions of the same). Here is a list of the 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1323colours with their names. 1499240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1500cube plus a 8 (24) colour greyscale ramp.
1501
1502B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1503C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1504number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1505colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
150624-bit colour space. When indexing collisions happen, the nearest old colour in
1507the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1508use many similar 24-bit colours. It's typically not a problem in common
1509scenarios.
1510
1511Here is a list of the ANSI colours with their names.
1324 1512
1325=begin table 1513=begin table
1326 1514
1327 B<color0> (black) = Black 1515 B<color0> (black) = Black
1328 B<color1> (red) = Red3 1516 B<color1> (red) = Red3
1348It is also possible to specify the colour values of B<foreground>, 1536It is also possible to specify the colour values of B<foreground>,
1349B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1537B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1350a number 0-15, as a convenient shorthand to reference the colour name of 1538a number 0-15, as a convenient shorthand to reference the colour name of
1351color0-color15. 1539color0-color15.
1352 1540
1353In addition to the colours defined above, @@RXVT_NAME@@ offers an 1541The following text gives values for the standard 88 colour mode (and
1354additional 72 colours. The first 64 of those (with indices 16 to 79) 1542values for the 256 colour mode in parentheses).
1355consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135616>), followed by 8 additional shades of gray (with indices 80 to 87).
1357 1543
1544The RGB cube uses indices 16..79 (16..231) using the following formulas:
1545
1546 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1547 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1548
1549The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1550steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1551the RGB cube.
1552
1358Together, all those colours implement the 88 colour xterm colours. Only 1553Together, all those colours implement the 88 (256) colour xterm
1359the first 16 can be changed using resources currently, the rest can only 1554colours. Only the first 16 can be changed using resources currently, the
1360be changed via command sequences ("escape codes"). 1555rest can only be changed via command sequences ("escape codes").
1556
1557Applications are advised to use terminfo or command sequences to discover
1558number and RGB values of all colours (yes, you can query this...).
1361 1559
1362Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1560Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1363always swapping the foreground/background colours. This is in contrast to 1561always swapping the foreground/background colours. This is in contrast to
1364I<xterm>(1) where the colours are only swapped if they have not otherwise 1562I<xterm>(1) where the colours are only swapped if they have not otherwise
1365been specified. For example, 1563been specified. For example,
1366 1564
1367=over 4
1368
1369=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1565 @@RXVT_NAME@@ -fg Black -bg White -rv
1370 1566
1371would yield White on Black, while on I<xterm>(1) it would yield Black 1567would yield White on Black, while on I<xterm>(1) it would yield Black on
1372on White. 1568White.
1373
1374=back
1375 1569
1376=head2 ALPHA CHANNEL SUPPORT 1570=head2 ALPHA CHANNEL SUPPORT
1377 1571
1378If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1572If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1379their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1573their act together, rxvt-unicode will do its own alpha channel management:
1380(recommended, but B<MUST> have 4 digits/component) colour specifications, 1574
1381in addition to the ones provided by X, where the additional A component 1575You can prefix any colour with an opaqueness percentage enclosed in
1576brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1577(0-100) that specifies the opacity of the colour, where C<0> is completely
1578transparent and C<100> is completely opaque. For example, C<[50]red> is a
1579half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1580is the recommended format to specify transparency values, and works with
1581all ways to specify a colour.
1582
1583For complete control, rxvt-unicode also supports
1584C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1585specifications, where the additional C<aaaa> component specifies opacity
1382specifies opacity (alpha) values. The minimum value of C<0> is completely 1586(alpha) values. The minimum value of C<0000> is completely transparent,
1383transparent). You can also prefix any color with C<[a]>, where C<a> is on 1587while C<ffff> is completely opaque). The two example colours from
1384to four hex digits specifiying the opacity value. 1588earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1589C<rgba:0000/ff00/0000/f332>.
1385 1590
1386You probably need to specify B<"-depth 32">, too, and have the luck that 1591You probably need to specify B<"-depth 32">, too, to force a visual with
1387your X-server uses ARGB pixel layout, as X is far from just supporting 1592alpha channels, and have the luck that your X-server uses ARGB pixel
1388ARGB visuals out of the box, and rxvt-unicode just fudges around. 1593layout, as X is far from just supporting ARGB visuals out of the box, and
1594rxvt-unicode just fudges around.
1389 1595
1390For example, the following selects an almost completely transparent red 1596For example, the following selects an almost completely transparent black
1391background, and an almost opaque pink foreground: 1597background, and an almost opaque pink foreground:
1392 1598
1393 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1599 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1394 1600
1395I<Please note that transparency of any kind if completely unsupported by 1601When not using a background image, then the interpretation of the
1396the author. Don't bug him with installation questions!> 1602alpha channel is up to your compositing manager (most interpret it as
1603transparency of course).
1604
1605When using a background pixmap or pseudo-transparency, then the background
1606colour will always behave as if it were completely transparent (so the
1607background image shows instead), regardless of how it was specified, while
1608other colours will either be transparent as specified (the background
1609image will show through) on servers supporting the RENDER extension, or
1610fully opaque on servers not supporting the RENDER EXTENSION.
1611
1612Please note that due to bugs in Xft, specifying alpha values might result
1613in garbage being displayed when the X-server does not support the RENDER
1614extension.
1397 1615
1398=head1 ENVIRONMENT 1616=head1 ENVIRONMENT
1399 1617
1400B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1618B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1401 1619
1407resources or on the command line. 1625resources or on the command line.
1408 1626
1409=item B<COLORTERM> 1627=item B<COLORTERM>
1410 1628
1411Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1629Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1412compiled with XPM support, and optionally with the added extension 1630compiled with background image support, and optionally with the added
1413C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1631extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1632screen.
1414 1633
1415=item B<COLORFGBG> 1634=item B<COLORFGBG>
1416 1635
1417Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1636Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1418the colour code used as default foreground/text colour (or the string 1637the colour code used as default foreground/text colour (or the string
1419C<default> to indicate that the default-colour escape sequence is to be 1638C<default> to indicate that the default-colour escape sequence is to be
1420used), C<bg> is the colour code used as default background colour (or the 1639used), C<bg> is the colour code used as default background colour (or the
1421string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1640string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1422was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1641was compiled with background image support. Libraries like C<ncurses>
1423(and do) use this information to optimize screen output. 1642and C<slang> can (and do) use this information to optimize screen output.
1424 1643
1425=item B<WINDOWID> 1644=item B<WINDOWID>
1426 1645
1427Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1646Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1428window, which usually has subwindows for the scrollbar, the terminal 1647window, which usually has subwindows for the scrollbar, the terminal
1434C<--with-terminfo=PATH>. 1653C<--with-terminfo=PATH>.
1435 1654
1436=item B<DISPLAY> 1655=item B<DISPLAY>
1437 1656
1438Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1657Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1439display in its child processes. 1658display in its child processes if C<-display> isn't used to override. It
1659defaults to C<:0> if it doesn't exist.
1440 1660
1441=item B<SHELL> 1661=item B<SHELL>
1442 1662
1443The shell to be used for command execution, defaults to C</bin/sh>. 1663The shell to be used for command execution, defaults to C</bin/sh>.
1444 1664
1445=item B<RXVT_SOCKET> 1665=item B<RXVT_SOCKET> [I<sic>]
1446 1666
1447The unix domain socket path used by @@RXVT_NAME@@c(1) and 1667The unix domain socket path used by @@RXVT_NAME@@c(1) and
1448@@RXVT_NAME@@d(1). 1668@@RXVT_NAME@@d(1).
1449 1669
1450Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1670Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1671
1672=item B<URXVT_PERL_LIB>
1673
1674Additional F<:>-separated library search path for perl extensions. Will be
1675searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1676directory.
1677
1678=item B<URXVT_PERL_VERBOSITY>
1679
1680See L<@@RXVT_NAME@@perl>(3).
1451 1681
1452=item B<HOME> 1682=item B<HOME>
1453 1683
1454Used to locate the default directory for the unix domain socket for 1684Used to locate the default directory for the unix domain socket for
1455daemon communications and to locate various resource files (such as 1685daemon communications and to locate various resource files (such as
1456C<.Xdefaults>) 1686C<.Xdefaults>)
1457 1687
1458=item B<XAPPLRESDIR> 1688=item B<XAPPLRESDIR>
1459 1689
1460Directory where various X resource files are being located. 1690Directory where application-specific X resource files are located.
1461 1691
1462=item B<XENVIRONMENT> 1692=item B<XENVIRONMENT>
1463 1693
1464If set and accessible, gives the name of a X resource file to be loaded by 1694If set and accessible, gives the name of a X resource file to be loaded by
1465@@RXVT_NAME@@. 1695@@RXVT_NAME@@.
1470 1700
1471=over 4 1701=over 4
1472 1702
1473=item B</usr/lib/X11/rgb.txt> 1703=item B</usr/lib/X11/rgb.txt>
1474 1704
1475Color names. 1705Colour names.
1476 1706
1477=back 1707=back
1478 1708
1479=head1 SEE ALSO 1709=head1 SEE ALSO
1480 1710
1711@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1481@@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) 1712@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1482 1713
1483=head1 CURRENT PROJECT COORDINATOR 1714=head1 CURRENT PROJECT COORDINATOR
1484 1715
1485=over 4 1716=over 4
1486 1717
1487=item Project Coordinator 1718=item Project Coordinator
1488 1719
1489Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1720Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1490 1721
1491L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1722L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1492 1723
1493=back 1724=back
1494 1725
1498 1729
1499=item John Bovey 1730=item John Bovey
1500 1731
1501University of Kent, 1992, wrote the original Xvt. 1732University of Kent, 1992, wrote the original Xvt.
1502 1733
1503=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1734=item Rob Nation <nation@rocket.sanders.lockheed.com>
1504 1735
1505very heavily modified Xvt and came up with Rxvt 1736very heavily modified Xvt and came up with Rxvt
1506 1737
1507=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1738=item Angelo Haritsis <ah@doc.ic.ac.uk>
1508 1739
1509wrote the Greek Keyboard Input (no longer in code) 1740wrote the Greek Keyboard Input (no longer in code)
1510 1741
1511=item mj olesen L<< <olesen@me.QueensU.CA> >> 1742=item mj olesen <olesen@me.QueensU.CA>
1512 1743
1513Wrote the menu system. 1744Wrote the menu system.
1514 1745
1515Project Coordinator (changes.txt 2.11 to 2.21) 1746Project Coordinator (changes.txt 2.11 to 2.21)
1516 1747
1517=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1748=item Oezguer Kesim <kesim@math.fu-berlin.de>
1518 1749
1519Project Coordinator (changes.txt 2.21a to 2.4.5) 1750Project Coordinator (changes.txt 2.21a to 2.4.5)
1520 1751
1521=item Geoff Wing L<< <gcw@pobox.com> >> 1752=item Geoff Wing <gcw@pobox.com>
1522 1753
1523Rewrote screen display and text selection routines. 1754Rewrote screen display and text selection routines.
1524 1755
1525Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1756Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1526 1757
1527=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1758=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1528 1759
1529Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1760Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1530extension, random hacks, numerous bugfixes and extensions. 1761extension, random hacks, numerous bugfixes and extensions.
1531 1762
1532Project Coordinator (Changes 1.0 -) 1763Project Coordinator (Changes 1.0 -)
1533 1764
1534=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1765=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1535 1766
1536Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1767pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1537 1768
1538=back 1769=back
1539 1770

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines