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.132 by root, Mon Jun 18 13:38:12 2007 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines