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.118 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 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 possible
114visual ids).
115
103=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
104 117
105Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
106 119
107=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
108 121
109Turn on/off simulated reverse video; resource B<reverseVideo>. 122Turn on/off simulated reverse video; resource B<reverseVideo>.
110 123
111=item B<-j>|B<+j> 124=item B<-j>|B<+j>
112 125
113Turn on/off jump scrolling; resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 127
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 128=item B<-ss>|B<+ss>
116 129
117Turn on/off inheriting parent window's pixmap. Alternative form is 130Turn 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 131
124=item B<-fade> I<number> 132=item B<-fade> I<number>
125 133
126Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
130=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
131 139
132Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
133is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
134 142
135=item B<-tint> I<colour> 143=item B<-icon> I<file>
136 144
137Tint the transparent background pixmap with the given colour when 145Compile I<pixbuf>: Use the specified image as application icon. This
138transparency is enabled with B<-tr> or B<-ip>. This only works for 146is used by many window managers, taskbars and pagers to represent the
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 147application 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 148
151=item B<-bg> I<colour> 149=item B<-bg> I<colour>
152 150
153Window background colour; resource B<background>. 151Window background colour; resource B<background>.
154 152
155=item B<-fg> I<colour> 153=item B<-fg> I<colour>
156 154
157Window foreground colour; resource B<foreground>. 155Window 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 156
166=item B<-cr> I<colour> 157=item B<-cr> I<colour>
167 158
168The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
169 160
214italic> >> characters are to be printed. See resource B<boldItalicFont> 205italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 206for details.
216 207
217=item B<-is>|B<+is> 208=item B<-is>|B<+is>
218 209
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
221details. 212details.
222 213
223=item B<-name> I<name> 214=item B<-name> I<name>
224 215
242 233
243=item B<-sb>|B<+sb> 234=item B<-sb>|B<+sb>
244 235
245Turn on/off scrollbar; resource B<scrollBar>. 236Turn on/off scrollbar; resource B<scrollBar>.
246 237
238=item B<-sr>|B<+sr>
239
240Put scrollbar on right/left; resource B<scrollBar_right>.
241
242=item B<-st>|B<+st>
243
244Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
245resource B<scrollBar_floating>.
246
247=item B<-si>|B<+si> 247=item B<-si>|B<+si>
248 248
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 249Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 250B<scrollTtyOutput> has opposite effect.
251 251
257=item B<-sw>|B<+sw> 257=item B<-sw>|B<+sw>
258 258
259Turn on/off scrolling with the scrollback buffer as new lines appear. 259Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 260This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 261B<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 262
272=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
273 264
274If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 266actual wide characters in the screen buffer, which makes it possible to
279 270
280=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
281 272
282Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
283 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
284=item B<-iconic> 279=item B<-iconic>
285 280
286Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
287Alternative form is B<-ic>. 282Alternative form is B<-ic>.
288 283
304 299
305=item B<-bl> 300=item B<-bl>
306 301
307Compile I<frills>: Set MWM hints to request a borderless window, i.e. 302Compile 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 303if honoured by the WM, the rxvt-unicode window will not have window
309decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
310 306
311=item B<-override-redirect> 307=item B<-override-redirect>
312 308
313Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>. 310B<override-redirect>.
311
312=item B<-dockapp>
313
314Sets the initial state of the window to WithdrawnState, which makes
315window managers that support this extension treat it as a dockapp.
315 316
316=item B<-sbg> 317=item B<-sbg>
317 318
318Compile I<frills>: Disable the usage of the built-in block graphics/line 319Compile I<frills>: Disable the usage of the built-in block graphics/line
319drawing characters and just rely on what the specified fonts provide. Use 320drawing characters and just rely on what the specified fonts provide. Use
322 323
323=item B<-lsp> I<number> 324=item B<-lsp> I<number>
324 325
325Compile I<frills>: Lines (pixel height) to insert between each row of 326Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 327the display. Useful to work around font rendering problems; resource
327B<linespace>. 328B<lineSpace>.
329
330=item B<-letsp> I<number>
331
332Compile I<frills>: Amount to adjust the computed character width by
333to control overall letter spacing. Negative values will tighten up the
334letter spacing, positive values will space letters out more. Useful to
335work around odd font metrics; resource B<letterSpace>.
328 336
329=item B<-tn> I<termname> 337=item B<-tn> I<termname>
330 338
331This option specifies the name of the terminal type to be set in the 339This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 340B<TERM> environment variable. This terminal type must exist in the
386for more info. 394for more info.
387 395
388=item B<-tcw> 396=item B<-tcw>
389 397
390Change the meaning of triple-click selection with the left mouse 398Change the meaning of triple-click selection with the left mouse
399button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 400in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 401the end of the logical line only. resource B<tripleclickwords>.
393 402
394=item B<-insecure> 403=item B<-insecure>
395 404
396Enable "insecure" mode, which currently enables most of the escape 405Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 406sequences that echo strings. See the resource B<insecure> for more
417 426
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 427Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 428will 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 429it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 430user; resource B<hold>.
431
432=item B<-cd> I<path>
433
434Sets the working directory for the shell (or the command specified via
435B<-e>). The I<path> must be an absolute path and it must exist for
436@@RXVT_NAME@@ to start; resource B<chdir>.
437
438=item B<-xrm> I<string>
439
440Works like the X Toolkit option of the same name, by adding the I<string>
441as if it were specified in a resource file. Resource values specified this
442way take precedence over all other resource specifications.
443
444Note that you need to use the I<same> syntax as in the .Xdefaults file,
445e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
446options can be specified as long-options on the commandline, so use
447of B<-xrm> is mostly limited to cases where you want to specify other
448resources (e.g. for input methods) or for compatibility with other
449programs.
422 450
423=item B<-keysym.>I<sym> I<string> 451=item B<-keysym.>I<sym> I<string>
424 452
425Remap a key symbol. See resource B<keysym>. 453Remap a key symbol. See resource B<keysym>.
426 454
452 }); 480 });
453 481
454=item B<-pty-fd> I<file descriptor> 482=item B<-pty-fd> I<file descriptor>
455 483
456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 484Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
457pair but instead use the given file handle as the tty master. This is 485pair but instead use the given file descriptor as the tty master. This is
458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 486useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
459without having to run a program within it. 487without having to run a program within it.
460 488
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 489If 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 490entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 491yourself if you want that.
464 492
465As an extremely special case, specifying C<-1> will completely suppress 493As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 494pty/tty operations, which is probably only useful in conjunction with some
495perl extension that manages the terminal.
467 496
468Here is a example in perl that illustrates how this option can be used (a 497Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 498longer example is in F<doc/pty-fd>):
470 499
471 use IO::Pty; 500 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 514Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 515this terminal instance. See resource B<perl-ext> for details.
487 516
488=back 517=back
489 518
490=head1 RESOURCES (available also as long-options) 519=head1 RESOURCES
491 520
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 521Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 522options) compiled into your version. All resources are also available as
523long-options.
494 524
495You can set and change the resources using X11 tools like B<xrdb>. Many 525You 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 526distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 527starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 528with later settings overwriting earlier ones:
499 529
500 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 530 1. app-defaults file in $XAPPLRESDIR
531 2. $HOME/.Xdefaults
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 532 3. RESOURCE_MANAGER property on root-window of screen 0
503 4. SCREEN_RESOURCES for the current screen 533 4. SCREEN_RESOURCES property on root-window of the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 534 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
535 6. resources specified via -xrm on the commandline
505 536
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 538names: 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 539common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 540configured, while the class name B<URxvt> allows resources unique to
519=item B<depth:> I<bitdepth> 550=item B<depth:> I<bitdepth>
520 551
521Compile I<xft>: Attempt to find a visual with the given bit depth; 552Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>. 553option B<-depth>.
523 554
555=item B<buffered:> I<boolean>
556
557Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
558On some card/driver combination enabling it slightly decreases
559performance, on most it greatly helps it. The slowdown is small, so it
560should normally be enabled.
561
524=item B<geometry:> I<geom> 562=item B<geometry:> I<geom>
525 563
526Create the window with the specified X window geometry [default 80x24]; 564Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 565option B<-geometry>.
528 566
541Use the specified colour for the colour value I<n>, where 0-7 579Use the specified colour for the colour value I<n>, where 0-7
542corresponds to low-intensity (normal) colours and 8-15 corresponds to 580corresponds to low-intensity (normal) colours and 8-15 corresponds to
543high-intensity (bold = bright foreground, blink = bright background) 581high-intensity (bold = bright foreground, blink = bright background)
544colours. The canonical names are as follows: 0=black, 1=red, 2=green, 582colours. 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 5833=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
546names used are listed in the B<COLORS AND GRAPHICS> section. 584names used are listed in the B<COLOURS AND GRAPHICS> section.
547 585
548Colours higher than 15 cannot be set using resources (yet), but can be 586Colours higher than 15 cannot be set using resources (yet), but can be
549changed using an escape command (see @@RXVT_NAME@@(7)). 587changed using an escape command (see @@RXVT_NAME@@(7)).
550 588
551Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 589Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
562=item B<colorUL:> I<colour> 600=item B<colorUL:> I<colour>
563 601
564Use the specified colour to display underlined characters when the 602Use the specified colour to display underlined characters when the
565foreground colour is the default. 603foreground colour is the default.
566 604
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> 605=item B<underlineColor:> I<colour>
573 606
574If set, use the specified colour as the colour for the underline 607If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 608itself. If unset, use the foreground colour.
609
610=item B<highlightColor:> I<colour>
611
612If set, use the specified colour as the background for highlighted
613characters. If unset, use reverse video.
614
615=item B<highlightTextColor:> I<colour>
616
617If set and highlightColor is set, use the specified colour as the
618foreground for highlighted characters.
576 619
577=item B<cursorColor:> I<colour> 620=item B<cursorColor:> I<colour>
578 621
579Use the specified colour for the cursor. The default is to use the 622Use the specified colour for the cursor. The default is to use the
580foreground colour; option B<-cr>. 623foreground colour; option B<-cr>.
587 630
588=item B<reverseVideo:> I<boolean> 631=item B<reverseVideo:> I<boolean>
589 632
590B<True>: simulate reverse video by foreground and background colours; 633B<True>: simulate reverse video by foreground and background colours;
591option B<-rv>. B<False>: regular screen colours [default]; option 634option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 635B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593 636
594=item B<jumpScroll:> I<boolean> 637=item B<jumpScroll:> I<boolean>
595 638
596B<True>: specify that jump scrolling should be used. When scrolling 639B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
641has been read, resulting in fewer updates while still displaying every
642received line; option B<-j>.
643
598B<False>: specify that smooth scrolling should be used; option B<+j>. 644B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
645force a screen refresh on each new line it received; option B<+j>.
599 646
600=item B<inheritPixmap:> I<boolean> 647=item B<skipScroll:> I<boolean>
601 648
602B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 650receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 651(around 60 times per second), resulting in far fewer updates. This can
652result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
653option B<-ss>.
605 654
606I<Please note that transparency of any kind if completely unsupported by 655B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 656if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>.
608 658
609=item B<fading:> I<number> 659=item B<fading:> I<number>
610 660
611Fade the text by the given percentage when focus is lost; option B<-fade>. 661Fade the text by the given percentage when focus is lost; option B<-fade>.
612 662
613=item B<fadeColor:> I<colour> 663=item B<fadeColor:> I<colour>
614 664
615Fade to this colour, when fading is used (see B<fading:>). The default 665Fade to this colour, when fading is used (see B<fading:>). The default
616colour is black; option B<-fadecolor>. 666colour is black; option B<-fadecolor>.
617 667
618=item B<tintColor:> I<colour> 668=item B<iconFile:> I<file>
619 669
620Tint the transparent background pixmap with the given colour; option 670Set 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 671
628=item B<scrollColor:> I<colour> 672=item B<scrollColor:> I<colour>
629 673
630Use the specified colour for the scrollbar [default #B2B2B2]. 674Use the specified colour for the scrollbar [default #B2B2B2].
631 675
636 680
637=item B<borderColor:> I<colour> 681=item B<borderColor:> I<colour>
638 682
639The colour of the border around the text area and between the scrollbar 683The colour of the border around the text area and between the scrollbar
640and the text. 684and 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 685
658=item B<font:> I<fontlist> 686=item B<font:> I<fontlist>
659 687
660Select the fonts to be used. This is a comma separated list of font names 688Select 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 689that 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 712it is named first) and thus defines the character cell grid to be 9 pixels
685wide and 15 pixels high. 713wide and 15 pixels high.
686 714
687The second font is just used to add additional unicode characters not in 715The second font is just used to add additional unicode characters not in
688the base font, likewise the third, which is unfortunately non-bold, but 716the 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 717the bold version of the font does contain fewer characters, so this is a
690useful supplement. 718useful supplement.
691 719
692The third font is an Xft font with aliasing turned off, and the characters 720The 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 721are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694contains other characters, but we are not interested in them. 722contains other characters, but we are not interested in them.
718text font will being used for the given style. 746text font will being used for the given style.
719 747
720=item B<intensityStyles:> I<boolean> 748=item B<intensityStyles:> I<boolean>
721 749
722When font styles are not enabled, or this option is enabled (B<True>, 750When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 751option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 752intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 753option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 754reachable.
727 755
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> 756=item B<title:> I<string>
740 757
741Set window title string, the default title is the command-line 758Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 759specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 760name; option B<-title>.
751=item B<mapAlert:> I<boolean> 768=item B<mapAlert:> I<boolean>
752 769
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 770B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 771de-iconify (map) on receipt of a bell character [default].
755 772
773=item B<urgentOnBell:> I<boolean>
774
775B<True>: set the urgency hint for the wm on receipt of a bell character.
776B<False>: do not set the urgency hint [default].
777
778@@RXVT_NAME@@ resets the urgency hint on every focus change.
779
756=item B<visualBell:> I<boolean> 780=item B<visualBell:> I<boolean>
757 781
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 782B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 783B<False>: no visual bell [default]; option B<+vb>.
760 784
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 807 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 808
785This creates a new file in your home directory with the screen contents 809This creates a new file in your home directory with the screen contents
786every time you hit C<Print>. 810every time you hit C<Print>.
787 811
812=item B<scrollstyle:> I<mode>
813
814Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
815the author's favourite.
816
817=item B<thickness:> I<number>
818
819Set the scrollbar width in pixels.
820
788=item B<scrollBar:> I<boolean> 821=item B<scrollBar:> I<boolean>
789 822
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 823B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 824disable the scrollbar; option B<+sb>.
792 825
811B<False>: do not scroll to bottom when tty receives output; option 844B<False>: do not scroll to bottom when tty receives output; option
812B<+si>. 845B<+si>.
813 846
814=item B<scrollWithBuffer:> I<boolean> 847=item B<scrollWithBuffer:> I<boolean>
815 848
816B<True>: scroll with scrollback buffer when tty receives new lines (and 849B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 850try to show the same lines) and B<scrollTtyOutput> is False; option
818with scrollback buffer when tty receives new lines; option B<+sw>. 851B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
852new lines; option B<+sw>.
819 853
820=item B<scrollTtyKeypress:> I<boolean> 854=item B<scrollTtyKeypress:> I<boolean>
821 855
822B<True>: scroll to bottom when a non-special key is pressed. Special keys 856B<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 857are those which are intercepted by rxvt-unicode for special handling and
854=item B<termName:> I<termname> 888=item B<termName:> I<termname>
855 889
856Specifies the terminal type name to be set in the B<TERM> environment 890Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 891variable; option B<-tn>.
858 892
859=item B<linespace:> I<number> 893=item B<lineSpace:> I<number>
860 894
861Specifies number of lines (pixel height) to insert between each row of 895Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 896the display [default 0]; option B<-lsp>.
863 897
864=item B<meta8:> I<boolean> 898=item B<meta8:> I<boolean>
878 912
879=item B<cursorBlink:> I<boolean> 913=item B<cursorBlink:> I<boolean>
880 914
881B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 915B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882option B<-bc>. 916option B<-bc>.
917
918=item B<cursorUnderline:> I<boolean>
919
920B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
921option B<-uc>.
883 922
884=item B<pointerBlank:> I<boolean> 923=item B<pointerBlank:> I<boolean>
885 924
886B<True>: blank the pointer when a key is pressed or after a set number 925B<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 926of seconds of inactivity. B<False>: the pointer is always visible
901large number (e.g. C<987654321>) to effectively disable the timeout. 940large number (e.g. C<987654321>) to effectively disable the timeout.
902 941
903=item B<backspacekey:> I<string> 942=item B<backspacekey:> I<string>
904 943
905The string to send when the backspace key is pressed. If set to B<DEC> 944The 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> 945or 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 946(code 8) - which can be reversed with the appropriate DEC private mode
908escape sequence. 947escape sequence.
909 948
910=item B<deletekey:> I<string> 949=item B<deletekey:> I<string>
911 950
916=item B<cutchars:> I<string> 955=item B<cutchars:> I<string>
917 956
918The characters used as delimiters for double-click word selection 957The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 958(whitespace delimiting is added automatically if resource is given).
920 959
921When the selection extension is in use (the default if compiled in, see 960When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 961in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 962characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 963will be created). In this mode, characters outside ISO-8859-1 can be used.
925 964
926When the selection extension is not used, only ISO-8859-1 characters can 965When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 966be used. If not specified, the built-in default is used:
928 967
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 968B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 969
931=item B<preeditType:> I<style> 970=item B<preeditType:> I<style>
932 971
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 972B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 973
988 1027
989Turn on/off secondary screen (default enabled). 1028Turn on/off secondary screen (default enabled).
990 1029
991=item B<secondaryScroll:> I<boolean> 1030=item B<secondaryScroll:> I<boolean>
992 1031
993Turn on/off secondary screen scroll (default enabled). If the this 1032Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1033option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1034scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1035to/from the secondary screen will instead scroll the screen up.
997 1036
998=item B<hold>: I<boolean> 1037=item B<hold>: I<boolean>
999 1038
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1039Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1040will 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 1041it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1042user.
1004 1043
1044=item B<chdir>: I<path>
1045
1046Sets the working directory for the shell (or the command specified via
1047B<-e>). The I<path> must be an absolute path and it must exist for
1048@@RXVT_NAME@@ to start. If it isn't specified then the current working
1049directory will be used; option B<-cd>.
1050
1005=item B<keysym.>I<sym>: I<string> 1051=item B<keysym.>I<sym>: I<action>
1006 1052
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1053Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1008intervening resource name B<keysym.> cannot be omitted. 1054resource name B<keysym.> cannot be omitted.
1009 1055
1010The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1056Using this resource, you can map key combinations such as
1011any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1057C<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>, 1058string 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>, 1059terminal scroll up or down the way you want it, or any other thing an
1014B<2>, B<3>, B<4>, B<5>. 1060extension might provide.
1061
1062The key combination that triggers the action, I<sym>, has the following format:
1063
1064 (modifiers-)key
1065
1066Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1067B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1068B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1069B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1015 1070
1016The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1071The 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 1072whatever 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 1073keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1019current application keymap mode state. 1074current application keymap mode state.
1020 1075
1021The spellings of I<key> can be obtained by using B<xev>(1) command or 1076Due the the large number of modifier combinations, a key mapping will
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1077match if I<at least> the specified identifiers are being set, and no other
1078key mappings with those and more bits are being defined. That means that
1079defining a mapping for C<a> will automatically provide definitions for
1080C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1081themselves. See the C<builtin:> action, below, for a way to work around
1082this when this is a problem.
1083
1084The spelling of I<key> depends on your implementation of X. An easy way to
1085find a key name is to use the B<xev>(1) command. You can find a list by
1086looking 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 1087the 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 1088value (B<0x0000 - 0xFFFF>).
1025performed in an exact manner; however, the closest match is assured.
1026 1089
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1090As 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, 1091escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1092number), 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.
1032 1093
1033Please note that you need to double the C<\> in resource files, as 1094An action starts with an action prefix that selects a certain type
1034Xlib itself does its own de-escaping (you can use C<\033> instead of 1095of action, followed by a colon. An action string without colons is
1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1096interpreted as a literal string to pass to the tty (as if it was
1036processing). 1097prefixed with C<string:>).
1037 1098
1038You can define a range of keysyms in one shot by providing a I<string> 1099The following action prefixes are known - extensions can provide
1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1100additional prefixes:
1040should be a character not used by the strings.
1041 1101
1042Its usage can be demonstrated by an example: 1102=over 4
1043 1103
1044 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1104=item string:STRING
1045 1105
1046The above line is equivalent to the following three lines: 1106If the I<action> starts with C<string:> (or otherwise contains no colons),
1107then the remaining C<STRING> will be passed to the program running in the
1108terminal. For example, you could replace whatever Shift-Tab outputs by the
1109string C<echo rm -rf /> followed by a newline:
1047 1110
1048 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1049 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1050 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1051 1112
1113This could in theory be used to completely redefine your keymap.
1114
1115=item command:STRING
1116
1052If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1117If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1053is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119the opposite of C<string:> - instead of sending it to the program running
1120in the terminal, it will be treated as if it were program output). This is
1121most useful to feed command sequences into @@RXVT_NAME@@.
1122
1054example the following means "change the current locale to C<zh_CN.GBK> 1123For example the following means "change the current locale to C<zh_CN.GBK>
1055when Control-Meta-c is being pressed": 1124when Control-Meta-c is being pressed":
1056 1125
1057 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1126 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058 1127
1059If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1128The following example will map Control-Meta-1 and Control-Meta-2 to
1060is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1129the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1061manpage. For example, the F<selection> extension (activated via 1130font-switching at runtime:
1062C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063 1131
1064 URxvt.keysym.M-C-c: perl:selection:rot13 1132 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1133 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1065 1134
1066Due the the large number of modifier combinations, a defined key mapping 1135Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1067will match if at I<at least> the specified identifiers are being set, and 1136info):
1068no other key mappings with those and more bits are being defined. That
1069means that defining a key map for C<a> will automatically provide
1070definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071mappings themselves.
1072 1137
1073Unfortunately, this will override built-in key mappings. For example 1138 URxvt.keysym.M-C-3: command:\033[8;25;80t
1139 URxvt.keysym.M-C-4: command:\033[8;48;110t
1140
1141=item builtin:
1142
1143The builtin action is the action that @@RXVT_NAME@@ would execute if no
1144key binding existed for the key combination. The obvious use is to undo
1145the effect of existing bindings. The not so obvious use is to reinstate
1146bindings when another binding overrides too many modifiers.
1147
1074if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1148For example if you overwrite the C<Insert> key you will disable
1075C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1149@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1076user-defined keymap using the C<builtin:> replacement: 1150"holes" into the user-defined keymap using the C<builtin:> replacement:
1077 1151
1078 URxvt.keysym.Insert: <my insert key sequence> 1152 URxvt.keysym.Insert: <my insert key sequence>
1079 URxvt.keysym.S-Insert: builtin: 1153 URxvt.keysym.S-Insert: builtin:
1080 1154
1081The first line defines a mapping for C<Insert> and I<any> combination 1155The first line defines a mapping for C<Insert> and I<any> combination
1082of modifiers. The second line re-establishes the default mapping for 1156of modifiers. The second line re-establishes the default mapping for
1083C<Shift-Insert>. 1157C<Shift-Insert>.
1084 1158
1085The following example will map Control-Meta-1 and Control-Meta-2 to 1159=item builtin-string:
1086the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1087font-switching at runtime:
1088 1160
1089 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1161This action is mainly useful to restore string mappings for keys that
1090 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1162have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1163difficult to explain - basically, this action will send the string to the
1164application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1165action for it.
1091 1166
1092Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1167An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1093info): 1168selection when you press C<Shift-Insert>. With the following bindings, it
1169would instead emit the (undocumented, but what applications running in the
1170terminal might expect) sequence C<ESC [ 2 $> instead:
1094 1171
1095 URxvt.keysym.M-C-3: command:\033[8;25;80t 1172 URxvt.keysym.S-Insert: builtin-string:
1096 URxvt.keysym.M-C-4: command:\033[8;48;110t 1173 URxvt.keysym.C-S-Insert: builtin:
1174
1175The first line disables the paste functionality for that key
1176combination, and the second reinstates the default behaviour for
1177C<Control-Shift-Insert>, which would otherwise be overridden.
1178
1179Similarly, to let applications gain access to the C<C-M-c> (copy to
1180clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this:
1182
1183 URxvt.keysym.C-S-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string:
1185
1186=item EXTENSION:STRING
1187
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1189extension of the same name. The extension will be loaded automatically if
1190necessary.
1191
1192Not all extensions define key actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively).
1196
1197From the silly examples department, this will rot13-"encrypt"
1198@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1199keyboards:
1200
1201 URxvt.keysym.M-C-c: selection:rot13
1202
1203=item perl:STRING *DEPRECATED*
1204
1205This is a deprecated way of passing key mappings to perl extensions. It is
1206still supported, but should not be used anymore.
1207
1208=back
1097 1209
1098=item B<perl-ext-common>: I<string> 1210=item B<perl-ext-common>: I<string>
1099 1211
1100=item B<perl-ext>: I<string> 1212=item B<perl-ext>: I<string>
1101 1213
1103use in this terminal instance; option B<-pe>. 1215use in this terminal instance; option B<-pe>.
1104 1216
1105Extension names can be prefixed with a C<-> sign to prohibit using 1217Extension names can be prefixed with a C<-> sign to prohibit using
1106them. This can be useful to selectively disable some extensions loaded 1218them. This can be useful to selectively disable some extensions loaded
1107by default, or specified via the C<perl-ext-common> resource. For 1219by default, or specified via the C<perl-ext-common> resource. For
1108example, C<default,-selection> will use all the default extension except 1220example, C<default,-selection> will use all the default extensions except
1109C<selection>. 1221C<selection>.
1110 1222
1111Extension names can also be followed by an argument in angle brackets 1223The default set includes the C<selection>, C<option-popup>,
1112(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1224C<selection-popup> and C<readline> extensions, any extensions that define
1113searchable scrollback to Alt/Meta-s). Mentioning the same extension 1225keybindings via C<BINDING> meta comments, extensions loaded because
1114multiple times with different arguments will pass multiple arguments to 1226their resources/commandline switches were used, and extensions which are
1115the extension. 1227mentioned in B<keysym> resources.
1116 1228
1117Each extension is looked up in the library directories, loaded if 1229Each extension is looked up in the library directories, loaded if
1118necessary, and bound to the current terminal instance. 1230necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the
1232first one found will be used.
1119 1233
1120If both of these resources are the empty string, then the perl 1234If both of these resources are the empty string, then the perl interpreter
1121interpreter will not be initialized. The idea behind two options is that 1235will not be initialized. The rationale for having two options is that
1122B<perl-ext-common> will be used for extensions that should be available to 1236B<perl-ext-common> will be used for extensions that should be available to
1123all instances, while B<perl-ext> is used for specific instances. 1237all instances, while B<perl-ext> is used for specific instances.
1124 1238
1125=item B<perl-eval>: I<string> 1239=item B<perl-eval>: I<string>
1126 1240
1127Perl code to be evaluated when all extensions have been registered. See 1241Perl code to be evaluated when all extensions have been registered. See
1128the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1242the @@RXVT_NAME@@perl(3) manpage.
1129will be ignored when running setuid/setgid.
1130 1243
1131=item B<perl-lib>: I<path> 1244=item B<perl-lib>: I<path>
1132 1245
1133Colon-separated list of additional directories that hold extension 1246Colon-separated list of additional directories that hold extension
1134scripts. When looking for extensions specified by the C<perl> resource, 1247scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1135@@RXVT_NAME@@ will first look in these directories and then in 1248in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1136F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1249lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137will be ignored when running setuid/setgid.
1138 1250
1139See the @@RXVT_NAME@@perl(3) manpage. 1251See the @@RXVT_NAME@@perl(3) manpage.
1140 1252
1141=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1253=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142 1254
1146=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1147 1259
1148Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1149for details. 1261for details.
1150 1262
1151=item B<searchable-scrollback:> I<keysym> 1263=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1152 1264
1153Sets the hotkey that starts the incremental scrollback buffer search 1265This resource is deprecated and will be removed. Use a B<keysym> resource
1154(default: C<M-s>). 1266instead, e.g.:
1155 1267
1268 URxvt.keysym.M-s: searchable-scrollback:start
1269
1156=item B<urlLauncher>: I<string> 1270=item B<url-launcher>: I<string>
1157 1271
1158Specifies the program to be started with a URL argument. Used by the 1272Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions. 1273C<selection-popup> and C<matcher> perl extensions.
1160 1274
1161=item B<transient-for>: I<windowid> 1275=item B<transient-for>: I<windowid>
1162 1276
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1277Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164 1278
1165=item B<override-redirect>: I<boolean> 1279=item B<override-redirect>: I<boolean>
1166 1280
1167Compile I<frills>: Sets override-redirect for the terminal window, making 1281Compile I<frills>: Sets override-redirect for the terminal window, making
1168it almost invisible to window managers; option B<-override-redirect>. 1282it almost invisible to window managers; option B<-override-redirect>.
1283
1284=item B<iso14755:> I<boolean>
1285
1286Turn on/off ISO 14755 (default enabled).
1287
1288=item B<iso14755_52:> I<boolean>
1289
1290Turn on/off ISO 14755 5.2 mode (default enabled).
1291
1292=back
1293
1294=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1295
1296=over 4
1297
1298=item B<-pixmap> I<file[;oplist]>
1299
1300=item B<backgroundPixmap:> I<file[;oplist]>
1301
1302Compile I<pixbuf>: Use the specified image file as the window's
1303background and also optionally specify a colon separated list of
1304operations to modify it. Note that you may need to quote the C<;>
1305character when using the command line option, as C<;> is usually a
1306metacharacter in shells. Supported operations are:
1307
1308=over 4
1309
1310=item B<WxH+X+Y>
1311
1312sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1313scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1314scale of 0 disables scaling.
1315
1316=item B<op=tile>
1317
1318enables tiling
1319
1320=item B<op=keep-aspect>
1321
1322maintain the image aspect ratio when scaling
1323
1324=item B<op=root-align>
1325
1326use the position of the terminal window relative to the root window as
1327the image offset, simulating a root window background
1328
1329=back
1330
1331The default scale and position setting is C<100x100+50+50>.
1332Alternatively, a predefined set of templates can be used to achieve
1333the most common setups:
1334
1335=over 4
1336
1337=item B<style=tiled>
1338
1339the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1340
1341=item B<style=aspect-stretched>
1342
1343the image is scaled to fill the whole window maintaining the aspect
1344ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1345
1346=item B<style=stretched>
1347
1348the image is scaled to fill the whole window. Equivalent to 100x100
1349
1350=item B<style=centered>
1351
1352the image is centered with no scaling. Equivalent to 0x0+50+50
1353
1354=item B<style=root-tiled>
1355
1356the image is tiled with no scaling and using 'root' positioning.
1357Equivalent to 0x0:op=tile:op=root-align
1358
1359=back
1360
1361If multiple templates are specified the last one wins. Note that a
1362template overrides all the scale, position and operations settings.
1363
1364If used in conjunction with pseudo-transparency, the specified pixmap
1365will be blended over the transparent background using alpha-blending.
1366
1367=item B<-tr>|B<+tr>
1368
1369=item B<transparent:> I<boolean>
1370
1371Turn on/off pseudo-transparency by using the root pixmap as background.
1372
1373B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1374will be removed in future versions.
1375
1376=item B<-tint> I<colour>
1377
1378=item B<tintColor:> I<colour>
1379
1380Tint the transparent background with the given colour. Note that a
1381black tint yields a completely black image while a white tint yields
1382the image unchanged.
1383
1384=item B<-sh> I<number>
1385
1386=item B<shading:> I<number>
1387
1388Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1389A value of 100 means no shading.
1390
1391=item B<-blr> I<HxV>
1392
1393=item B<blurRadius:> I<HxV>
1394
1395Apply gaussian blur with the specified radius to the transparent
1396background. If a single number is specified, the vertical and
1397horizontal radii are considered to be the same. Setting one of the
1398radii to 1 and the other to a large number creates interesting effects
1399on some backgrounds. The maximum radius value is 128. An horizontal or
1400vertical radius of 0 disables blurring.
1401
1402=item B<path:> I<path>
1403
1404Specify the colon-delimited search path for finding background image files.
1169 1405
1170=back 1406=back
1171 1407
1172=head1 THE SCROLLBAR 1408=head1 THE SCROLLBAR
1173 1409
1192application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1428application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1429(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1430up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195respectively. 1431respectively.
1196 1432
1197=head1 TEXT SELECTION AND INSERTION 1433=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198 1434
1199The behaviour of text selection and insertion mechanism is similar to 1435The behaviour of text selection and insertion/pasting mechanism is similar
1200I<xterm>(1). 1436to I<xterm>(1).
1201 1437
1202=over 4 1438=over 4
1203 1439
1204=item B<Selection>: 1440=item B<Selecting>:
1205 1441
1206Left click at the beginning of the region, drag to the end of the region 1442Left click at the beginning of the region, drag to the end of the region
1207and release; Right click to extend the marked region; Left double-click 1443and release; Right click to extend the marked region; Left double-click
1208to select a word; Left triple-click to select the entire logical line 1444to select a word; Left triple-click to select the entire logical line
1209(which can span multiple screen lines), unless modified by resource 1445(which can span multiple screen lines), unless modified by resource
1213(Compile: I<frills>) will create a rectangular selection instead of a 1449(Compile: I<frills>) will create a rectangular selection instead of a
1214normal one. In this mode, every selected row becomes its own line in the 1450normal one. In this mode, every selected row becomes its own line in the
1215selection, and trailing whitespace is visually underlined and removed from 1451selection, and trailing whitespace is visually underlined and removed from
1216the selection. 1452the selection.
1217 1453
1218=item B<Insertion>: 1454=item B<Pasting>:
1219 1455
1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1456Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221window causes the value of the PRIMARY selection (or CLIPBOARD with the 1457window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222Meta modifier) to be inserted as if it had been typed on the keyboard. 1458B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223 1459
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1460Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too. 1461inserted too.
1226 1462
1463rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1464<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1465binding causes the value of the internal selection to be copied to the
1466CLIPBOARD selection, while the second binding causes the value of the
1467CLIPBOARD selection to be inserted.
1468
1227=back 1469=back
1228 1470
1229=head1 CHANGING FONTS 1471=head1 CHANGING FONTS
1230 1472
1231Changing fonts (or font sizes, respectively) via the keypad is not yet 1473Changing fonts (or font sizes, respectively) via the keypad is not yet
1244 1486
1245=head1 ISO 14755 SUPPORT 1487=head1 ISO 14755 SUPPORT
1246 1488
1247ISO 14755 is a standard for entering and viewing unicode characters 1489ISO 14755 is a standard for entering and viewing unicode characters
1248and character codes using the keyboard. It consists of 4 parts. The 1490and character codes using the keyboard. It consists of 4 parts. The
1249first part is available rxvt-unicode has been compiled with 1491first part is available if rxvt-unicode has been compiled with
1250C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1492C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251with C<--enable-iso14755>. 1493with C<--enable-iso14755>.
1252 1494
1253=over 4 1495=over 4
1254 1496
1312B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1554B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1313it can be seen via the I<who(1)> command, and can accept messages. To 1555it can be seen via the I<who(1)> command, and can accept messages. To
1314allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1556allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1315on some systems or setgid to root or to some other group on others. 1557on some systems or setgid to root or to some other group on others.
1316 1558
1317=head1 COLORS AND GRAPHICS 1559=head1 COLOURS AND GRAPHICS
1318 1560
1319In addition to the default foreground and background colours, 1561In addition to the default foreground and background colours,
1320B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1562B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1321high-intensity bold/blink versions of the same). Here is a list of the 1563high-intensity (potentially bold/blink) versions of the same, and 72 (or
1322colours with their names. 1564240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1565cube plus a 8 (24) colour greyscale ramp.
1566
1567Here is a list of the ANSI colours with their names.
1323 1568
1324=begin table 1569=begin table
1325 1570
1326 B<color0> (black) = Black 1571 B<color0> (black) = Black
1327 B<color1> (red) = Red3 1572 B<color1> (red) = Red3
1347It is also possible to specify the colour values of B<foreground>, 1592It is also possible to specify the colour values of B<foreground>,
1348B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1593B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1349a number 0-15, as a convenient shorthand to reference the colour name of 1594a number 0-15, as a convenient shorthand to reference the colour name of
1350color0-color15. 1595color0-color15.
1351 1596
1352In addition to the colours defined above, @@RXVT_NAME@@ offers an 1597The following text gives values for the standard 88 colour mode (and
1353additional 72 colours. The first 64 of those (with indices 16 to 79) 1598values for the 256 colour mode in parentheses).
1354consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135516>), followed by 8 additional shades of gray (with indices 80 to 87).
1356 1599
1600The RGB cube uses indices 16..79 (16..231) using the following formulas:
1601
1602 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1603 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1604
1605The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1606steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1607the RGB cube.
1608
1357Together, all those colours implement the 88 colour xterm colours. Only 1609Together, all those colours implement the 88 (256) colour xterm
1358the first 16 can be changed using resources currently, the rest can only 1610colours. Only the first 16 can be changed using resources currently, the
1359be changed via command sequences ("escape codes"). 1611rest can only be changed via command sequences ("escape codes").
1612
1613Applications are advised to use terminfo or command sequences to discover
1614number and RGB values of all colours (yes, you can query this...).
1360 1615
1361Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1616Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362always swapping the foreground/background colours. This is in contrast to 1617always swapping the foreground/background colours. This is in contrast to
1363I<xterm>(1) where the colours are only swapped if they have not otherwise 1618I<xterm>(1) where the colours are only swapped if they have not otherwise
1364been specified. For example, 1619been specified. For example,
1365 1620
1366=over 4
1367
1368=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1621 @@RXVT_NAME@@ -fg Black -bg White -rv
1369 1622
1370would yield White on Black, while on I<xterm>(1) it would yield Black 1623would yield White on Black, while on I<xterm>(1) it would yield Black on
1371on White. 1624White.
1372
1373=back
1374 1625
1375=head2 ALPHA CHANNEL SUPPORT 1626=head2 ALPHA CHANNEL SUPPORT
1376 1627
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1628If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1629their act together, rxvt-unicode will do its own alpha channel management:
1379(recommended, but B<MUST> have 4 digits/component) colour specifications, 1630
1380in addition to the ones provided by X, where the additional A component 1631You can prefix any colour with an opaqueness percentage enclosed in
1632brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1633(0-100) that specifies the opacity of the colour, where C<0> is completely
1634transparent and C<100> is completely opaque. For example, C<[50]red> is a
1635half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1636is the recommended format to specify transparency values, and works with
1637all ways to specify a colour.
1638
1639For complete control, rxvt-unicode also supports
1640C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1641specifications, where the additional C<aaaa> component specifies opacity
1381specifies opacity (alpha) values. The minimum value of C<0> is completely 1642(alpha) values. The minimum value of C<0000> is completely transparent,
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on 1643while C<ffff> is completely opaque). The two example colours from
1383to four hex digits specifiying the opacity value. 1644earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1645C<rgba:0000/ff00/0000/f332>.
1384 1646
1385You probably need to specify B<"-depth 32">, too, and have the luck that 1647You probably need to specify B<"-depth 32">, too, to force a visual with
1386your X-server uses ARGB pixel layout, as X is far from just supporting 1648alpha channels, and have the luck that your X-server uses ARGB pixel
1387ARGB visuals out of the box, and rxvt-unicode just fudges around. 1649layout, as X is far from just supporting ARGB visuals out of the box, and
1650rxvt-unicode just fudges around.
1388 1651
1389For example, the following selects an almost completely transparent red 1652For example, the following selects an almost completely transparent black
1390background, and an almost opaque pink foreground: 1653background, and an almost opaque pink foreground:
1391 1654
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1655 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1393 1656
1394I<Please note that transparency of any kind if completely unsupported by 1657When not using a background image, then the interpretation of the
1395the author. Don't bug him with installation questions!> 1658alpha channel is up to your compositing manager (most interpret it as
1659transparency of course).
1660
1661When using a background pixmap or pseudo-transparency, then the background
1662colour will always behave as if it were completely transparent (so the
1663background image shows instead), regardless of how it was specified, while
1664other colours will either be transparent as specified (the background
1665image will show through) on servers supporting the RENDER extension, or
1666fully opaque on servers not supporting the RENDER EXTENSION.
1667
1668Please note that due to bugs in Xft, specifying alpha values might result
1669in garbage being displayed when the X-server does not support the RENDER
1670extension.
1396 1671
1397=head1 ENVIRONMENT 1672=head1 ENVIRONMENT
1398 1673
1399B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1674B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400 1675
1406resources or on the command line. 1681resources or on the command line.
1407 1682
1408=item B<COLORTERM> 1683=item B<COLORTERM>
1409 1684
1410Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1685Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411compiled with XPM support, and optionally with the added extension 1686compiled with background image support, and optionally with the added
1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1687extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1688screen.
1413 1689
1414=item B<COLORFGBG> 1690=item B<COLORFGBG>
1415 1691
1416Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1692Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417the colour code used as default foreground/text colour (or the string 1693the colour code used as default foreground/text colour (or the string
1418C<default> to indicate that the default-colour escape sequence is to be 1694C<default> to indicate that the default-colour escape sequence is to be
1419used), C<bg> is the colour code used as default background colour (or the 1695used), C<bg> is the colour code used as default background colour (or the
1420string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1696string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1697was compiled with background image support. Libraries like C<ncurses>
1422(and do) use this information to optimize screen output. 1698and C<slang> can (and do) use this information to optimize screen output.
1423 1699
1424=item B<WINDOWID> 1700=item B<WINDOWID>
1425 1701
1426Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1702Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427window, which usually has subwindows for the scrollbar, the terminal 1703window, which usually has subwindows for the scrollbar, the terminal
1433C<--with-terminfo=PATH>. 1709C<--with-terminfo=PATH>.
1434 1710
1435=item B<DISPLAY> 1711=item B<DISPLAY>
1436 1712
1437Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1713Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438display in its child processes. 1714display in its child processes if C<-display> isn't used to override. It
1715defaults to C<:0> if it doesn't exist.
1439 1716
1440=item B<SHELL> 1717=item B<SHELL>
1441 1718
1442The shell to be used for command execution, defaults to C</bin/sh>. 1719The shell to be used for command execution, defaults to C</bin/sh>.
1443 1720
1444=item B<RXVT_SOCKET> 1721=item B<RXVT_SOCKET> [I<sic>]
1445 1722
1446The unix domain socket path used by @@RXVT_NAME@@c(1) and 1723The unix domain socket path used by @@RXVT_NAME@@c(1) and
1447@@RXVT_NAME@@d(1). 1724@@RXVT_NAME@@d(1).
1448 1725
1449Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1726Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1727
1728=item B<URXVT_PERL_LIB>
1729
1730Additional F<:>-separated library search path for perl extensions. Will be
1731searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1732directory.
1733
1734=item B<URXVT_PERL_VERBOSITY>
1735
1736See L<@@RXVT_NAME@@perl>(3).
1450 1737
1451=item B<HOME> 1738=item B<HOME>
1452 1739
1453Used to locate the default directory for the unix domain socket for 1740Used to locate the default directory for the unix domain socket for
1454daemon communications and to locate various resource files (such as 1741daemon communications and to locate various resource files (such as
1455C<.Xdefaults>) 1742C<.Xdefaults>)
1456 1743
1457=item B<XAPPLRESDIR> 1744=item B<XAPPLRESDIR>
1458 1745
1459Directory where various X resource files are being located. 1746Directory where application-specific X resource files are located.
1460 1747
1461=item B<XENVIRONMENT> 1748=item B<XENVIRONMENT>
1462 1749
1463If set and accessible, gives the name of a X resource file to be loaded by 1750If set and accessible, gives the name of a X resource file to be loaded by
1464@@RXVT_NAME@@. 1751@@RXVT_NAME@@.
1469 1756
1470=over 4 1757=over 4
1471 1758
1472=item B</usr/lib/X11/rgb.txt> 1759=item B</usr/lib/X11/rgb.txt>
1473 1760
1474Color names. 1761Colour names.
1475 1762
1476=back 1763=back
1477 1764
1478=head1 SEE ALSO 1765=head1 SEE ALSO
1479 1766
1767@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1480@@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) 1768@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1481 1769
1482=head1 CURRENT PROJECT COORDINATOR 1770=head1 CURRENT PROJECT COORDINATOR
1483 1771
1484=over 4 1772=over 4
1485 1773
1486=item Project Coordinator 1774=item Project Coordinator
1487 1775
1488Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1776Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1489 1777
1490L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1778L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1491 1779
1492=back 1780=back
1493 1781
1497 1785
1498=item John Bovey 1786=item John Bovey
1499 1787
1500University of Kent, 1992, wrote the original Xvt. 1788University of Kent, 1992, wrote the original Xvt.
1501 1789
1502=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1790=item Rob Nation <nation@rocket.sanders.lockheed.com>
1503 1791
1504very heavily modified Xvt and came up with Rxvt 1792very heavily modified Xvt and came up with Rxvt
1505 1793
1506=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1794=item Angelo Haritsis <ah@doc.ic.ac.uk>
1507 1795
1508wrote the Greek Keyboard Input (no longer in code) 1796wrote the Greek Keyboard Input (no longer in code)
1509 1797
1510=item mj olesen L<< <olesen@me.QueensU.CA> >> 1798=item mj olesen <olesen@me.QueensU.CA>
1511 1799
1512Wrote the menu system. 1800Wrote the menu system.
1513 1801
1514Project Coordinator (changes.txt 2.11 to 2.21) 1802Project Coordinator (changes.txt 2.11 to 2.21)
1515 1803
1516=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1804=item Oezguer Kesim <kesim@math.fu-berlin.de>
1517 1805
1518Project Coordinator (changes.txt 2.21a to 2.4.5) 1806Project Coordinator (changes.txt 2.21a to 2.4.5)
1519 1807
1520=item Geoff Wing L<< <gcw@pobox.com> >> 1808=item Geoff Wing <gcw@pobox.com>
1521 1809
1522Rewrote screen display and text selection routines. 1810Rewrote screen display and text selection routines.
1523 1811
1524Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1812Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525 1813
1526=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1814=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1527 1815
1528Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1816Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1529extension, random hacks, numerous bugfixes and extensions. 1817extension, random hacks, numerous bugfixes and extensions.
1530 1818
1531Project Coordinator (Changes 1.0 -) 1819Project Coordinator (Changes 1.0 -)
1532 1820
1533=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1821=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1534 1822
1535Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1823pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1536 1824
1537=back 1825=back
1538 1826

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines