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.160 by root, Fri Jan 25 18:42:23 2008 UTC vs.
Revision 1.263 by sf-exg, Sat Jan 20 08:00:50 2024 UTC

84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85Orange'. 85Orange'.
86 86
87The following options are available: 87The following options are available:
88 88
89=over 4 89=over
90 90
91=item B<-help>, B<--help> 91=item B<-help>, B<--help>
92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
95=item B<-display> I<displayname> 95=item B<-display> I<displayname>
96 96
97Attempt 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>
98respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
99B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile 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;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 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 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 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 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
111=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
112 118
113Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
114 120
115=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
122 128
123=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
124 130
125Turn 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>.
126 132
127=item B<-tr>|B<+tr> 133=item B<-fps> I<number>
128 134
129Turn on/off illusion of a transparent window background; resource B<transparent>. 135Compile I<frills>: Set the refresh interval (in frames per second or
130 136negative seconds); resource B<refreshRate>.
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 137
137=item B<-fade> I<number> 138=item B<-fade> I<number>
138 139
139Fade the text by the given percentage when focus is lost. Small values 140Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 141fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 144=item B<-fadecolor> I<colour>
144 145
145Fade to this colour when fading is used (see B<-fade>). The default colour 146Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 147is opaque black. resource B<fadeColor>.
147 148
148=item B<-tint> I<colour> 149=item B<-icon> I<file>
149 150
150Tint the transparent background pixmap with the given colour when 151Compile I<pixbuf>: Use the specified image as application icon. This
151transparency is enabled with B<-tr>. This only works for 152is used by many window managers, taskbars and pagers to represent the
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 153application window; resource I<iconFile>.
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186 154
187=item B<-bg> I<colour> 155=item B<-bg> I<colour>
188 156
189Window background colour; resource B<background>. 157Window background colour; resource B<background>.
190 158
191=item B<-fg> I<colour> 159=item B<-fg> I<colour>
192 160
193Window foreground colour; resource B<foreground>. 161Window foreground colour; resource B<foreground>.
194
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196
197Compile I<afterimage>: Specify image file for the background and also
198optionally specify its scaling with a geometry string. Note you may need to
199add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>.
201 162
202=item B<-cr> I<colour> 163=item B<-cr> I<colour>
203 164
204The cursor colour; resource B<cursorColor>. 165The cursor colour; resource B<cursorColor>.
205 166
264 225
265=item B<-ls>|B<+ls> 226=item B<-ls>|B<+ls>
266 227
267Start as a login-shell/sub-shell; resource B<loginShell>. 228Start as a login-shell/sub-shell; resource B<loginShell>.
268 229
230=item B<-mc> I<milliseconds>
231
232Specify the maximum time between multi-click selections.
233
269=item B<-ut>|B<+ut> 234=item B<-ut>|B<+ut>
270 235
271Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 236Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
272B<utmpInhibit>. 237B<utmpInhibit>.
273 238
315 280
316=item B<-bc>|B<+bc> 281=item B<-bc>|B<+bc>
317 282
318Blink the cursor; resource B<cursorBlink>. 283Blink the cursor; resource B<cursorBlink>.
319 284
285=item B<-uc>|B<+uc>
286
287Make the cursor underlined; resource B<cursorUnderline>.
288
320=item B<-iconic> 289=item B<-iconic>
321 290
322Start iconified, if the window manager supports that option. 291Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 292Alternative form is B<-ic>.
324 293
340 309
341=item B<-bl> 310=item B<-bl>
342 311
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 312Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344if honoured by the WM, the rxvt-unicode window will not have window 313if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 314decorations; resource B<borderLess>. If the window manager does not
315support MWM hints (e.g. kwin), enables override-redirect mode.
346 316
347=item B<-override-redirect> 317=item B<-override-redirect>
348 318
349Compile I<frills>: Sets override-redirect on the window; resource 319Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 320B<override-redirect>.
321
322=item B<-dockapp>
323
324Sets the initial state of the window to WithdrawnState, which makes
325window managers that support this extension treat it as a dockapp.
351 326
352=item B<-sbg> 327=item B<-sbg>
353 328
354Compile I<frills>: Disable the usage of the built-in block graphics/line 329Compile I<frills>: Disable the usage of the built-in block graphics/line
355drawing characters and just rely on what the specified fonts provide. Use 330drawing characters and just rely on what the specified fonts provide. Use
359=item B<-lsp> I<number> 334=item B<-lsp> I<number>
360 335
361Compile I<frills>: Lines (pixel height) to insert between each row of 336Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 337the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 338B<lineSpace>.
339
340=item B<-letsp> I<number>
341
342Compile I<frills>: Amount to adjust the computed character width by
343to control overall letter spacing. Negative values will tighten up the
344letter spacing, positive values will space letters out more. Useful to
345work around odd font metrics; resource B<letterSpace>.
364 346
365=item B<-tn> I<termname> 347=item B<-tn> I<termname>
366 348
367This option specifies the name of the terminal type to be set in the 349This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 350B<TERM> environment variable. This terminal type must exist in the
403=item B<-pt> I<style> 385=item B<-pt> I<style>
404 386
405Compile I<XIM>: input style for input method; B<OverTheSpot>, 387Compile I<XIM>: input style for input method; B<OverTheSpot>,
406B<OffTheSpot>, B<Root>; resource B<preeditType>. 388B<OffTheSpot>, B<Root>; resource B<preeditType>.
407 389
390If the perl extension C<xim-onthespot> is used (which is the default),
391then additionally the C<OnTheSpot> preedit type is available.
392
408=item B<-im> I<text> 393=item B<-im> I<text>
409 394
410Compile I<XIM>: input method name. resource B<inputMethod>. 395Compile I<XIM>: input method name. resource B<inputMethod>.
411 396
412=item B<-imlocale> I<string> 397=item B<-imlocale> I<string>
426Change the meaning of triple-click selection with the left mouse 411Change the meaning of triple-click selection with the left mouse
427button. Only effective when the original (non-perl) selection code is 412button. Only effective when the original (non-perl) selection code is
428in-use. Instead of selecting a full line it will extend the selection to 413in-use. Instead of selecting a full line it will extend the selection to
429the end of the logical line only. resource B<tripleclickwords>. 414the end of the logical line only. resource B<tripleclickwords>.
430 415
416=item B<-dpb>|B<+dpb>
417
418Compile frills: Disable (or enable) emitting bracketed paste mode
419sequences (default enabled). Bracketed paste mode allows programs
420to detect when something is pasted. Since more and more programs
421abuse this, these sequences can be disabled. The command sequences to
422enable and query paste mode will still work, but the actual bracket
423sequences will no longer be emitted. You can also toggle this from the
424ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
425
431=item B<-insecure> 426=item B<-insecure>
432 427
433Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
434sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
435info. 430info.
447 442
448=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
449 444
450Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
451B<secondaryScroll>. 446B<secondaryScroll>.
447
448=item B<-rm> I<mode>
449
450Compile I<frills>: Sets long line rewrapping behaviour on window resizes
451to one of B<auto> (the default), B<always> or B<never>. The latter two
452modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
453is non-empty, and wings lines (acts like B<never>) otherwise; resource
454B<rewrapMode>.
452 455
453=item B<-hold>|B<+hold> 456=item B<-hold>|B<+hold>
454 457
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 458Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 459will not immediately destroy its window when the program executed within
457it exits. Instead, it will wait till it is being killed or closed by the 460it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 461user; resource B<hold>.
462
463=item B<-cd> I<path>
464
465Sets the working directory for the shell (or the command specified via
466B<-e>). The I<path> must be an absolute path and it must exist for
467@@RXVT_NAME@@ to start; resource B<chdir>.
459 468
460=item B<-xrm> I<string> 469=item B<-xrm> I<string>
461 470
462Works like the X Toolkit option of the same name, by adding the I<string> 471Works like the X Toolkit option of the same name, by adding the I<string>
463as if it were specified in a resource file. Resource values specified this 472as if it were specified in a resource file. Resource values specified this
529 538
530 # now communicate with rxvt 539 # now communicate with rxvt
531 my $slave = $pty->slave; 540 my $slave = $pty->slave;
532 while (<$slave>) { print $slave "got <$_>\n" } 541 while (<$slave>) { print $slave "got <$_>\n" }
533 542
543Note that, despite what the name might imply, the file descriptor does not
544need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
545domain or tcp socket). While tty operations cannot be done in this case,
546B<@@RXVT_NAME@@> can still be remote controlled with it:
547
548 use Socket;
549 use Fcntl;
550
551 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
552 fcntl $slave, Fcntl::F_SETFD, 0;
553 system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
554 close $slave;
555
556 syswrite $URXVT, "Type a secret password: ";
557 my $secret = do { local $/ = "\r"; <$URXVT> };
558 print "Not so secret anymore: $secret\n";
559
534=item B<-pe> I<string> 560=item B<-pe> I<string>
535 561
536Comma-separated list of perl extension scripts to use (or not to use) in 562Comma-separated list of perl extension scripts to use (or not to use) in
537this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
538 564
547You can set and change the resources using X11 tools like B<xrdb>. Many 573You can set and change the resources using X11 tools like B<xrdb>. Many
548distribution do also load settings from the B<~/.Xresources> file when X 574distribution do also load settings from the B<~/.Xresources> file when X
549starts. @@RXVT_NAME@@ will consult the following files/resources in order, 575starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550with later settings overwriting earlier ones: 576with later settings overwriting earlier ones:
551 577
552 1. system-wide app-defaults file, either locale-dependent OR global
553 2. app-defaults file in $XAPPLRESDIR 578 1. app-defaults file in $XAPPLRESDIR
579 2. $HOME/.Xdefaults
554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 580 3. RESOURCE_MANAGER property on root-window of screen 0
555 4. SCREEN_RESOURCES for the current screen 581 4. SCREEN_RESOURCES property on root-window of the current screen
556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 582 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline 583 6. resources specified via -xrm on the commandline
558 584
559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 585Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 586names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
565be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
566settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
567check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
568extensions not documented here): 594extensions not documented here):
569 595
570=over 4 596=over
571 597
572=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
573 599
574Compile I<xft>: Attempt to find a visual with the given bit depth; 600Compile I<xft>: Attempt to find a visual with the given bit depth;
575option B<-depth>. 601option B<-depth>.
602
603=item B<buffered:> I<boolean>
604
605Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
606On some card/driver combination enabling it slightly decreases
607performance, on most it greatly helps it. The slowdown is small, so it
608should normally be enabled.
576 609
577=item B<geometry:> I<geom> 610=item B<geometry:> I<geom>
578 611
579Create the window with the specified X window geometry [default 80x24]; 612Create the window with the specified X window geometry [default 80x24];
580option B<-geometry>. 613option B<-geometry>.
594Use the specified colour for the colour value I<n>, where 0-7 627Use the specified colour for the colour value I<n>, where 0-7
595corresponds to low-intensity (normal) colours and 8-15 corresponds to 628corresponds to low-intensity (normal) colours and 8-15 corresponds to
596high-intensity (bold = bright foreground, blink = bright background) 629high-intensity (bold = bright foreground, blink = bright background)
597colours. The canonical names are as follows: 0=black, 1=red, 2=green, 630colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5983=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6313=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
599names used are listed in the B<COLORS AND GRAPHICS> section. 632names used are listed in the B<COLOURS AND GRAPHICS> section.
600 633
601Colours higher than 15 cannot be set using resources (yet), but can be 634Colours higher than 15 cannot be set using resources (yet), but can be
602changed using an escape command (see @@RXVT_NAME@@(7)). 635changed using an escape command (see @@RXVT_NAME@@(7)).
603 636
604Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 637Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
615=item B<colorUL:> I<colour> 648=item B<colorUL:> I<colour>
616 649
617Use the specified colour to display underlined characters when the 650Use the specified colour to display underlined characters when the
618foreground colour is the default. 651foreground colour is the default.
619 652
620=item B<colorRV:> I<colour>
621
622Use the specified colour as the background for reverse video characters
623when OPTION_HC is disabled (--disable-frills).
624
625=item B<underlineColor:> I<colour> 653=item B<underlineColor:> I<colour>
626 654
627If set, use the specified colour as the colour for the underline 655If set, use the specified colour as the colour for the underline
628itself. If unset, use the foreground colour. 656itself. If unset, use the foreground colour.
657
658=item B<highlightColor:> I<colour>
659
660If set, use the specified colour as the background for highlighted
661characters. If unset, use reverse video.
662
663=item B<highlightTextColor:> I<colour>
664
665If set and highlightColor is set, use the specified colour as the
666foreground for highlighted characters.
629 667
630=item B<cursorColor:> I<colour> 668=item B<cursorColor:> I<colour>
631 669
632Use the specified colour for the cursor. The default is to use the 670Use the specified colour for the cursor. The default is to use the
633foreground colour; option B<-cr>. 671foreground colour; option B<-cr>.
640 678
641=item B<reverseVideo:> I<boolean> 679=item B<reverseVideo:> I<boolean>
642 680
643B<True>: simulate reverse video by foreground and background colours; 681B<True>: simulate reverse video by foreground and background colours;
644option B<-rv>. B<False>: regular screen colours [default]; option 682option B<-rv>. B<False>: regular screen colours [default]; option
645B<+rv>. See note in B<COLORS AND GRAPHICS> section. 683B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
646 684
647=item B<jumpScroll:> I<boolean> 685=item B<jumpScroll:> I<boolean>
648 686
649B<True>: specify that jump scrolling should be used. When receiving lots 687B<True>: specify that jump scrolling should be used. When receiving lots
650of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 688of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
664 702
665B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
666if the refresh is too fast for the human eye to read anything (or the 704if the refresh is too fast for the human eye to read anything (or the
667monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
668 706
669=item B<transparent:> I<boolean> 707=item B<refreshRate:> I<number>
670 708
671Turn on/off illusion of a transparent window background. 709Compile I<frills>: When positive, sets the maximum refreshes per second
672 710(the default is C<60>). When zero or negative, sets the minimum interval
673B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 711between refreshes, negated. That is, positive numbers limit the number
674future versions. 712of refreshes per second to that number, similar to a fps limiter in
675 713games. A negative number gets negated and directly sets the minimum
676I<Please address all transparency related issues to Sasha Vasko at 714interval between refreshes, that is, C<10> and C<-0.1> both specify
677sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 715the same refresh interval (likewise C<50> and C<0.02>). Finally, zero
716makes @@RXVT_NAME@@ refresh as fast as possible. Fractional values are
717supported; option B<-fps>.
678 718
679=item B<fading:> I<number> 719=item B<fading:> I<number>
680 720
681Fade the text by the given percentage when focus is lost; option B<-fade>. 721Fade the text by the given percentage when focus is lost; option B<-fade>.
682 722
683=item B<fadeColor:> I<colour> 723=item B<fadeColor:> I<colour>
684 724
685Fade to this colour, when fading is used (see B<fading:>). The default 725Fade to this colour, when fading is used (see B<fading:>). The default
686colour is black; option B<-fadecolor>. 726colour is black; option B<-fadecolor>.
687 727
688=item B<tintColor:> I<colour> 728=item B<iconFile:> I<file>
689 729
690Tint the transparent background pixmap with the given colour; option 730Set the application icon pixmap; option B<-icon>.
691B<-tint>.
692
693=item B<shading:> I<number>
694
695Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
696in addition to tinting it; option B<-sh>.
697
698=item B<blendType:> I<string>
699
700Specify background blending type; option B<-blt>.
701
702=item B<blurRadius:> I<number>
703
704Apply Gaussian Blurr with the specified radius to the transparent
705background image; option B<-blr>.
706 731
707=item B<scrollColor:> I<colour> 732=item B<scrollColor:> I<colour>
708 733
709Use the specified colour for the scrollbar [default #B2B2B2]. 734Use the specified colour for the scrollbar [default #B2B2B2].
710 735
715 740
716=item B<borderColor:> I<colour> 741=item B<borderColor:> I<colour>
717 742
718The colour of the border around the text area and between the scrollbar 743The colour of the border around the text area and between the scrollbar
719and the text. 744and the text.
720
721=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
722
723Use the specified image file for the background and also
724optionally specify its scaling with a geometry string B<WxH+X+Y>,
725(default C<0x0+50+50>) in which B<"W" / "H"> specify the
726horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
727centre (percent). A scale of 0 displays the image with tiling. A scale
728of 1 displays the image without any scaling. A scale of 2 to 9 specifies
729an integer number of images in that direction. No image will be magnified
730beyond 10 times its original size. The maximum permitted scale is 1000.
731Additional operations can be specified after colon B<:op1:op2...>.
732Supported operations are:
733
734 tile force background image to be tiled and not scaled. Equivalent to 0x0
735 propscale will scale image keeping proportions
736 auto will scale image to match window size. Equivalent to 100x100
737 hscale will scale image horizontally to the window size
738 vscale will scale image vertically to the window size
739 scale will scale image to match window size
740 root will tile image as if it was a root window background, auto-adjusting
741 whenever terminal window moves
742
743If used in conjunction with B<-tr> option, the specified pixmap will be
744blended over transparency image using either alpha-blending, or any
745other blending type, specified with B<-blt "type"> option.
746
747=item B<path:> I<path>
748
749Specify the colon-delimited search path for finding background image files.
750 745
751=item B<font:> I<fontlist> 746=item B<font:> I<fontlist>
752 747
753Select the fonts to be used. This is a comma separated list of font names 748Select the fonts to be used. This is a comma separated list of font names
754that are checked in order when trying to find glyphs for characters. The 749that are checked in order when trying to find glyphs for characters. The
777it is named first) and thus defines the character cell grid to be 9 pixels 772it is named first) and thus defines the character cell grid to be 9 pixels
778wide and 15 pixels high. 773wide and 15 pixels high.
779 774
780The second font is just used to add additional unicode characters not in 775The second font is just used to add additional unicode characters not in
781the base font, likewise the third, which is unfortunately non-bold, but 776the base font, likewise the third, which is unfortunately non-bold, but
782the bold version of the font does contain less characters, so this is a 777the bold version of the font does contain fewer characters, so this is a
783useful supplement. 778useful supplement.
784 779
785The third font is an Xft font with aliasing turned off, and the characters 780The third font is an Xft font with aliasing turned off, and the characters
786are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 781are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
787contains other characters, but we are not interested in them. 782contains other characters, but we are not interested in them.
838=item B<urgentOnBell:> I<boolean> 833=item B<urgentOnBell:> I<boolean>
839 834
840B<True>: set the urgency hint for the wm on receipt of a bell character. 835B<True>: set the urgency hint for the wm on receipt of a bell character.
841B<False>: do not set the urgency hint [default]. 836B<False>: do not set the urgency hint [default].
842 837
838@@RXVT_NAME@@ resets the urgency hint on every focus change.
839
843=item B<visualBell:> I<boolean> 840=item B<visualBell:> I<boolean>
844 841
845B<True>: use visual bell on receipt of a bell character; option B<-vb>. 842B<True>: use visual bell on receipt of a bell character; option B<-vb>.
846B<False>: no visual bell [default]; option B<+vb>. 843B<False>: no visual bell [default]; option B<+vb>.
847 844
849 846
850B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 847B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
851the shell; option B<-ls>. B<False>: start as a normal sub-shell 848the shell; option B<-ls>. B<False>: start as a normal sub-shell
852[default]; option B<+ls>. 849[default]; option B<+ls>.
853 850
851=item B<multiClickTime:> I<number>
852
853Specify the maximum time in milliseconds between multi-click select
854events. The default is 500 milliseconds; option B<-mc>.
855
854=item B<utmpInhibit:> I<boolean> 856=item B<utmpInhibit:> I<boolean>
855 857
856B<True>: inhibit writing record into the system log file B<utmp>; 858B<True>: inhibit writing record into the system log file B<utmp>;
857option B<-ut>. B<False>: write record into the system log file B<utmp> 859option B<-ut>. B<False>: write record into the system log file B<utmp>
858[default]; option B<+ut>. 860[default]; option B<+ut>.
875=item B<scrollstyle:> I<mode> 877=item B<scrollstyle:> I<mode>
876 878
877Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 879Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878the author's favourite. 880the author's favourite.
879 881
882=item B<thickness:> I<number>
883
884Set the scrollbar width in pixels.
885
880=item B<scrollBar:> I<boolean> 886=item B<scrollBar:> I<boolean>
881 887
882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 888B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
883disable the scrollbar; option B<+sb>. 889disable the scrollbar; option B<+sb>.
884 890
897Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar 903Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
898thumb with the pointer on middle button press/drag. 904thumb with the pointer on middle button press/drag.
899 905
900=item B<scrollTtyOutput:> I<boolean> 906=item B<scrollTtyOutput:> I<boolean>
901 907
902B<True>: scroll to bottom when tty receives output; option B<-si>. 908B<True>: scroll to bottom when tty receives output; option B<+si>.
903B<False>: do not scroll to bottom when tty receives output; option 909B<False>: do not scroll to bottom when tty receives output; option
904B<+si>. 910B<-si>.
905 911
906=item B<scrollWithBuffer:> I<boolean> 912=item B<scrollWithBuffer:> I<boolean>
907 913
908B<True>: scroll with scrollback buffer when tty receives new lines (and 914B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
909B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 915try to show the same lines) and B<scrollTtyOutput> is False; option
910with scrollback buffer when tty receives new lines; option B<+sw>. 916B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
917new lines; option B<+sw>.
911 918
912=item B<scrollTtyKeypress:> I<boolean> 919=item B<scrollTtyKeypress:> I<boolean>
913 920
914B<True>: scroll to bottom when a non-special key is pressed. Special keys 921B<True>: scroll to bottom when a non-special key is pressed. Special keys
915are those which are intercepted by rxvt-unicode for special handling and 922are those which are intercepted by rxvt-unicode for special handling and
916are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 923are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
917bottom when a non-special key is pressed; option B<+sk>. 924bottom when a non-special key is pressed; option B<+sk>.
918 925
919=item B<saveLines:> I<number> 926=item B<saveLines:> I<number>
920 927
921Save I<number> lines in the scrollback buffer [default 64]. This 928Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
922resource is limited on most machines to 65535; option B<-sl>.
923 929
924=item B<internalBorder:> I<number> 930=item B<internalBorder:> I<number>
925 931
926Internal border of I<number> pixels. This resource is limited to 100; 932Internal border of I<number> pixels. This resource is limited to 100;
927option B<-b>. 933option B<-b>.
971=item B<cursorBlink:> I<boolean> 977=item B<cursorBlink:> I<boolean>
972 978
973B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 979B<True>: blink the cursor. B<False>: do not blink the cursor [default];
974option B<-bc>. 980option B<-bc>.
975 981
982=item B<cursorUnderline:> I<boolean>
983
984B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
985option B<-uc>.
986
976=item B<pointerBlank:> I<boolean> 987=item B<pointerBlank:> I<boolean>
977 988
978B<True>: blank the pointer when a key is pressed or after a set number 989B<True>: blank the pointer when a key is pressed or after a set number
979of seconds of inactivity. B<False>: the pointer is always visible 990of seconds of inactivity. B<False>: the pointer is always visible
980[default]. 991[default].
985 996
986=item B<pointerColor2:> I<colour> 997=item B<pointerColor2:> I<colour>
987 998
988Mouse pointer background colour. 999Mouse pointer background colour.
989 1000
1001=item B<pointerShape:> I<string>
1002
1003Compile I<frills>: Specifies the name of the mouse pointer shape
1004[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
1005file for possible values (omit the C<XC_> prefix).
1006
990=item B<pointerBlankDelay:> I<number> 1007=item B<pointerBlankDelay:> I<number>
991 1008
992Specifies number of seconds before blanking the pointer [default 2]. Use a 1009Specifies number of seconds before blanking the pointer [default 2]. Use a
993large number (e.g. C<987654321>) to effectively disable the timeout. 1010large number (e.g. C<987654321>) to effectively disable the timeout.
994 1011
995=item B<backspacekey:> I<string> 1012=item B<backspacekey:> I<string>
996 1013
997The string to send when the backspace key is pressed. If set to B<DEC> 1014The string to send when the backspace key is pressed. If set to B<DEC>
998or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1015or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
999(code 8) - which can be reversed with the appropriate DEC private mode 1016(code 8) - which can be reversed with the appropriate DEC private mode
1000escape sequence. 1017escape sequence.
1001 1018
1002=item B<deletekey:> I<string> 1019=item B<deletekey:> I<string>
1003 1020
1020 1037
1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1038B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1022 1039
1023=item B<preeditType:> I<style> 1040=item B<preeditType:> I<style>
1024 1041
1025B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1042B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1026 1043
1027=item B<inputMethod:> I<name> 1044=item B<inputMethod:> I<name>
1028 1045
1029I<name> of inputMethod to use; option B<-im>. 1046I<name> of inputMethod to use; option B<-im>.
1030 1047
1048 1065
1049Change the meaning of triple-click selection with the left mouse 1066Change the meaning of triple-click selection with the left mouse
1050button. Instead of selecting a full line it will extend the selection to 1067button. Instead of selecting a full line it will extend the selection to
1051the end of the logical line only; option B<-tcw>. 1068the end of the logical line only; option B<-tcw>.
1052 1069
1070=item B<disablePasteBrackets:> I<boolean>
1071
1072Prevent emission of paste bracket sequences; option B<-dpb>.
1073
1053=item B<insecure:> I<boolean> 1074=item B<insecure:> I<boolean>
1054 1075
1055Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1076Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1056echo arbitrary strings like the icon name or the locale. This could be 1077echo arbitrary strings like the icon name or the locale. This could be
1057abused if somebody gets 8-bit-clean access to your display, whether 1078abused if somebody gets 8-bit-clean access to your display, whether
1058through a mail client displaying mail bodies unfiltered or through 1079through a mail client displaying mail bodies unfiltered or through
1059write(1) or any other means. Therefore, these sequences are disabled by 1080write(1) or any other means. Therefore, these sequences are disabled by
1060default. (Note that many other terminals, including xterm, have these 1081default. (Note that many other terminals, including xterm, have these
1078 1099
1079=item B<secondaryScreen:> I<boolean> 1100=item B<secondaryScreen:> I<boolean>
1080 1101
1081Turn on/off secondary screen (default enabled). 1102Turn on/off secondary screen (default enabled).
1082 1103
1104=item B<rewrapMode:> I<mode>
1105
1106Sets long line rewrap behaviour on window resize to one of B<auto>
1107(default), B<always> or B<never>.
1108
1083=item B<secondaryScroll:> I<boolean> 1109=item B<secondaryScroll:> I<boolean>
1084 1110
1085Turn on/off secondary screen scroll (default enabled). If this 1111Turn on/off secondary screen scroll (default enabled). If this
1086option is enabled, scrolls on the secondary screen will change the 1112option is enabled, scrolls on the secondary screen will change the
1087scrollback buffer and switching to/from the secondary screen will 1113scrollback buffer and, when secondaryScreen is off, switching
1088instead scroll the screen up. 1114to/from the secondary screen will instead scroll the screen up.
1089 1115
1090=item B<hold>: I<boolean> 1116=item B<hold>: I<boolean>
1091 1117
1092Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1118Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093will not immediately destroy its window when the program executed within 1119will not immediately destroy its window when the program executed within
1094it exits. Instead, it will wait till it is being killed or closed by the 1120it exits. Instead, it will wait till it is being killed or closed by the
1095user. 1121user.
1096 1122
1123=item B<chdir>: I<path>
1124
1125Sets the working directory for the shell (or the command specified via
1126B<-e>). The I<path> must be an absolute path and it must exist for
1127@@RXVT_NAME@@ to start. If it isn't specified then the current working
1128directory will be used; option B<-cd>.
1129
1097=item B<keysym.>I<sym>: I<string> 1130=item B<keysym.>I<sym>: I<action>
1098 1131
1099Compile I<frills>: Associate I<string> with keysym I<sym>. The 1132Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1100intervening resource name B<keysym.> cannot be omitted. 1133resource name B<keysym.> cannot be omitted.
1101 1134
1102The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1135Using this resource, you can map key combinations such as
1103any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1136C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1104B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1137string than would normally result from that combination, making the
1105and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1138terminal scroll up or down the way you want it, or any other thing an
1106B<2>, B<3>, B<4>, B<5>. 1139extension might provide.
1140
1141The key combination that triggers the action, I<sym>, has the following format:
1142
1143 (modifiers-)key
1144
1145Where I<modifiers> can be any combination of the following full or
1146abbreviated modifier names:
1147
1148=begin table
1149
1150 B<ISOLevel3> B<I>
1151 B<AppKeypad> B<K>
1152 B<Control> B<C>
1153 B<NumLock> B<N>
1154 B<Shift> B<S>
1155 B<Meta> B<M> I<or> B<A>
1156 B<Lock> B<L>
1157 B<Mod1> B<1>
1158 B<Mod2> B<2>
1159 B<Mod3> B<3>
1160 B<Mod4> B<4>
1161 B<Mod5> B<5>
1162
1163=end table
1107 1164
1108The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1165The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1109whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1166whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1110keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1167keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1111current application keymap mode state. 1168current application keymap mode state.
1112 1169
1113The spellings of I<key> can be obtained by using B<xev>(1) command or 1170Due the the large number of modifier combinations, a key mapping will
1114searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1171match if I<at least> the specified identifiers are being set, and no other
1172key mappings with those and more bits are being defined. That means that
1173defining a mapping for C<a> will automatically provide definitions for
1174C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1175themselves. See the C<builtin:> action, below, for a way to work around
1176this when this is a problem.
1177
1178The spelling of I<key> depends on your implementation of X. An easy way to
1179find a key name is to use the B<xev>(1) command. You can find a list by
1180looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1115omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1181the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1116keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1182value (B<0x0000 - 0xFFFF>).
1117performed in an exact manner; however, the closest match is assured.
1118 1183
1119I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1184As with any resource value, the I<action> string may contain backslash
1185escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1120number), see RESOURCES in C<man 7 X> for futher details. 1186number), see RESOURCES in C<man 7 X> for further details.
1121 1187
1122You can define a range of keysyms in one shot by providing a I<string> 1188An action starts with an action prefix that selects a certain type
1123with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1189of action, followed by a colon. An action string without colons is
1190interpreted as a literal string to pass to the tty (as if it was
1191prefixed with C<string:>).
1192
1193The following action prefixes are known - extensions can provide
1194additional prefixes:
1195
1196=over
1197
1198=item string:STRING
1199
1200If the I<action> starts with C<string:> (or otherwise contains no colons),
1201then the remaining C<STRING> will be passed to the program running in the
1202terminal. For example, you could replace whatever Shift-Tab outputs by the
1203string C<echo rm -rf /> followed by a newline:
1204
1205 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1206
1207This could in theory be used to completely redefine your keymap.
1208
1209In addition, for actions of this type, you can define a range of
1210keysyms in one shot by loading the C<keysym-list> perl extension and
1211providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1124should be a character not used by the strings. 1212the delimiter `/' should be a character not used by the strings.
1125 1213
1126Its usage can be demonstrated by an example: 1214Its usage can be demonstrated by an example:
1127 1215
1128 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1216 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1129 1217
1130The above line is equivalent to the following three lines: 1218The above line is equivalent to the following three lines:
1131 1219
1132 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1220 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1133 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1221 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1134 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1222 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1135 1223
1224=item command:STRING
1225
1136If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1226If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1137is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1227is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1228the opposite of C<string:> - instead of sending it to the program running
1229in the terminal, it will be treated as if it were program output). This is
1230most useful to feed command sequences into @@RXVT_NAME@@.
1231
1138example the following means "change the current locale to C<zh_CN.GBK> 1232For example the following means "change the current locale to C<zh_CN.GBK>
1139when Control-Meta-c is being pressed": 1233when Control-Meta-c is being pressed":
1140 1234
1141 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1235 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1142 1236
1143If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1237The following example will map Control-Meta-1 and Control-Meta-2 to
1144is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1238the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1145manpage. For example, the F<selection> extension (activated via 1239font-switching at runtime:
1146C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1147 1240
1148 URxvt.keysym.M-C-c: perl:selection:rot13 1241 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1242 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1149 1243
1150Due the the large number of modifier combinations, a defined key mapping 1244Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1151will match if at I<at least> the specified identifiers are being set, and 1245info):
1152no other key mappings with those and more bits are being defined. That
1153means that defining a key map for C<a> will automatically provide
1154definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1155mappings themselves.
1156 1246
1157Unfortunately, this will override built-in key mappings. For example 1247 URxvt.keysym.M-C-3: command:\033[8;25;80t
1248 URxvt.keysym.M-C-4: command:\033[8;48;110t
1249
1250=item builtin:
1251
1252The builtin action is the action that @@RXVT_NAME@@ would execute if no
1253key binding existed for the key combination. The obvious use is to undo
1254the effect of existing bindings. The not so obvious use is to reinstate
1255bindings when another binding overrides too many modifiers.
1256
1158if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1257For example if you overwrite the C<Insert> key you will disable
1159C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1258@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1160user-defined keymap using the C<builtin:> replacement: 1259"holes" into the user-defined keymap using the C<builtin:> replacement:
1161 1260
1162 URxvt.keysym.Insert: <my insert key sequence> 1261 URxvt.keysym.Insert: <my insert key sequence>
1163 URxvt.keysym.S-Insert: builtin: 1262 URxvt.keysym.S-Insert: builtin:
1164 1263
1165The first line defines a mapping for C<Insert> and I<any> combination 1264The first line defines a mapping for C<Insert> and I<any> combination
1166of modifiers. The second line re-establishes the default mapping for 1265of modifiers. The second line re-establishes the default mapping for
1167C<Shift-Insert>. 1266C<Shift-Insert>.
1168 1267
1169The following example will map Control-Meta-1 and Control-Meta-2 to 1268=item builtin-string:
1170the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1171font-switching at runtime:
1172 1269
1173 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1270This action is mainly useful to restore string mappings for keys that
1174 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1271have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1272difficult to explain - basically, this action will send the string to the
1273application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1274action for it.
1175 1275
1176Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1276An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1177info): 1277selection when you press C<Shift-Insert>. With the following bindings, it
1278would instead emit the (undocumented, but what applications running in the
1279terminal might expect) sequence C<ESC [ 2 $> instead:
1178 1280
1179 URxvt.keysym.M-C-3: command:\033[8;25;80t 1281 URxvt.keysym.S-Insert: builtin-string:
1180 URxvt.keysym.M-C-4: command:\033[8;48;110t 1282 URxvt.keysym.C-S-Insert: builtin:
1283
1284The first line disables the paste functionality for that key
1285combination, and the second reinstates the default behaviour for
1286C<Control-Shift-Insert>, which would otherwise be overridden.
1287
1288Similarly, to let applications gain access to the C<C-M-c> (copy to
1289clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1290this:
1291
1292 URxvt.keysym.C-M-c: builtin-string:
1293 URxvt.keysym.C-M-v: builtin-string:
1294
1295=item EXTENSION:STRING
1296
1297An action of this form invokes the action B<STRING>, if any, provided
1298by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1299be loaded automatically if necessary.
1300
1301Not all extensions define actions, but popular extensions that do
1302include the I<selection> and I<matcher> extensions (documented in their
1303own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1304respectively).
1305
1306From the silly examples department, this will rot13-"encrypt"
1307@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1308keyboards:
1309
1310 URxvt.keysym.M-C-c: selection:rot13
1311
1312=item perl:STRING *DEPRECATED*
1313
1314This is a deprecated way of invoking commands provided by perl
1315extensions. It is still supported, but should not be used anymore.
1316
1317=back
1181 1318
1182=item B<perl-ext-common>: I<string> 1319=item B<perl-ext-common>: I<string>
1183 1320
1184=item B<perl-ext>: I<string> 1321=item B<perl-ext>: I<string>
1185 1322
1186Comma-separated list(s) of perl extension scripts (default: C<default>) to 1323Comma-separated list(s) of perl extension scripts (default: C<default>) to
1187use in this terminal instance; option B<-pe>. 1324use in this terminal instance; option B<-pe>.
1188 1325
1189Extension names can be prefixed with a C<-> sign to prohibit using 1326Extension names can be prefixed with a C<-> sign to remove them again, in
1190them. This can be useful to selectively disable some extensions loaded 1327case they had been specified earlier. This can be useful to selectively
1191by default, or specified via the C<perl-ext-common> resource. For 1328disable some extensions loaded by default, or specified via the
1192example, C<default,-selection> will use all the default extension except 1329C<perl-ext-common> resource. For example, C<default,-selection> will use
1193C<selection>. 1330all the default extensions except C<selection>.
1194 1331
1195Extension names can also be followed by an argument in angle brackets 1332To prohibit autoloading of extensions, you can prefix them with C</>,
1196(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1333which will make urxvt refuse to automatically load them (this can be
1197searchable scrollback to Alt/Meta-s). Mentioning the same extension 1334overridden, however, by specifying the extension name again without a
1198multiple times with different arguments will pass multiple arguments to 1335prefix, though). This does not prohibit extensions themselves loading
1199the extension. 1336other extensions. For example, C<default,/background> will keep the
1337C<background> extension from being loaded when a background OSC sequence
1338is received.
1339
1340The default set includes the C<selection>, C<option-popup>,
1341C<selection-popup>, C<readline>, C<searchable-scrollback> and
1342C<confirm-paste> extensions, as well as any extensions which are mentioned
1343in B<keysym> resources.
1344
1345Any extension such that a corresponding resource is given on the
1346command line is automatically appended to B<perl-ext>.
1200 1347
1201Each extension is looked up in the library directories, loaded if 1348Each extension is looked up in the library directories, loaded if
1202necessary, and bound to the current terminal instance. 1349necessary, and bound to the current terminal instance. When the library
1350search path contains multiple extension files of the same name, then the
1351first one found will be used.
1203 1352
1204If both of these resources are the empty string, then the perl 1353If both of these resources are the empty string, then the perl interpreter
1205interpreter will not be initialized. The idea behind two options is that 1354will not be initialized. The rationale for having two options is that
1206B<perl-ext-common> will be used for extensions that should be available to 1355B<perl-ext-common> will be used for extensions that should be available to
1207all instances, while B<perl-ext> is used for specific instances. 1356all instances, while B<perl-ext> is used for specific instances.
1208 1357
1209=item B<perl-eval>: I<string> 1358=item B<perl-eval>: I<string>
1210 1359
1211Perl code to be evaluated when all extensions have been registered. See 1360Perl code to be evaluated when all extensions have been registered. See
1212the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1361the @@RXVT_NAME@@perl(3) manpage.
1213will be ignored when running setuid/setgid.
1214 1362
1215=item B<perl-lib>: I<path> 1363=item B<perl-lib>: I<path>
1216 1364
1217Colon-separated list of additional directories that hold extension 1365Colon-separated list of additional directories that hold extension
1218scripts. When looking for extensions specified by the C<perl> resource, 1366scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1219@@RXVT_NAME@@ will first look in these directories and then in 1367in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1220F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1368lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1221will be ignored when running setuid/setgid.
1222 1369
1223See the @@RXVT_NAME@@perl(3) manpage. 1370See the @@RXVT_NAME@@perl(3) manpage.
1224 1371
1225=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1372=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226 1373
1230=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1377=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1231 1378
1232Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1379Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1233for details. 1380for details.
1234 1381
1235=item B<searchable-scrollback:> I<keysym> 1382=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1236 1383
1237Sets the hotkey that starts the incremental scrollback buffer search 1384This resource is deprecated and will be removed. Use a B<keysym> resource
1238(default: C<M-s>). 1385instead, e.g.:
1239 1386
1387 URxvt.keysym.M-s: searchable-scrollback:start
1388
1240=item B<urlLauncher>: I<string> 1389=item B<url-launcher>: I<string>
1241 1390
1242Specifies the program to be started with a URL argument. Used by the 1391Specifies the program to be started with a URL argument. Used by the
1243C<selection-popup> and C<matcher> perl extensions. 1392C<selection-popup> and C<matcher> perl extensions.
1244 1393
1245=item B<transient-for>: I<windowid> 1394=item B<transient-for>: I<windowid>
1248 1397
1249=item B<override-redirect>: I<boolean> 1398=item B<override-redirect>: I<boolean>
1250 1399
1251Compile I<frills>: Sets override-redirect for the terminal window, making 1400Compile I<frills>: Sets override-redirect for the terminal window, making
1252it almost invisible to window managers; option B<-override-redirect>. 1401it almost invisible to window managers; option B<-override-redirect>.
1402
1403=item B<iso14755:> I<boolean>
1404
1405Turn on/off ISO 14755 (default enabled).
1253 1406
1254=item B<iso14755_52:> I<boolean> 1407=item B<iso14755_52:> I<boolean>
1255 1408
1256Turn on/off ISO 14755 5.2 mode (default enabled). 1409Turn on/off ISO 14755 5.2 mode (default enabled).
1257 1410
1285=head1 THE SELECTION: SELECTING AND PASTING TEXT 1438=head1 THE SELECTION: SELECTING AND PASTING TEXT
1286 1439
1287The behaviour of text selection and insertion/pasting mechanism is similar 1440The behaviour of text selection and insertion/pasting mechanism is similar
1288to I<xterm>(1). 1441to I<xterm>(1).
1289 1442
1290=over 4 1443=over
1291 1444
1292=item B<Selecting>: 1445=item B<Selecting>:
1293 1446
1294Left click at the beginning of the region, drag to the end of the region 1447Left click at the beginning of the region, drag to the end of the region
1295and release; Right click to extend the marked region; Left double-click 1448and release; Right click to extend the marked region; Left double-click
1310B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1463B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1311 1464
1312Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1465Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1313inserted too. 1466inserted too.
1314 1467
1468rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1469B<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1470binding causes the value of the internal selection to be copied to the
1471CLIPBOARD selection, while the second binding causes the value of the
1472CLIPBOARD selection to be inserted.
1473
1315=back 1474=back
1316 1475
1317=head1 CHANGING FONTS 1476=head1 CHANGING FONTS
1318 1477
1319Changing fonts (or font sizes, respectively) via the keypad is not yet 1478Changing fonts (or font sizes, respectively) via the keypad is not yet
1336and character codes using the keyboard. It consists of 4 parts. The 1495and character codes using the keyboard. It consists of 4 parts. The
1337first part is available if rxvt-unicode has been compiled with 1496first part is available if rxvt-unicode has been compiled with
1338C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1497C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1339with C<--enable-iso14755>. 1498with C<--enable-iso14755>.
1340 1499
1341=over 4 1500=over
1342 1501
1343=item * 5.1: Basic method 1502=item * 5.1: Basic method
1344 1503
1345This allows you to enter unicode characters using their hexcode. 1504This allows you to enter unicode characters using their hexcode.
1346 1505
1400B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1559B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1401it can be seen via the I<who(1)> command, and can accept messages. To 1560it can be seen via the I<who(1)> command, and can accept messages. To
1402allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1561allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1403on some systems or setgid to root or to some other group on others. 1562on some systems or setgid to root or to some other group on others.
1404 1563
1405=head1 COLORS AND GRAPHICS 1564=head1 COLOURS AND GRAPHICS
1406 1565
1407In addition to the default foreground and background colours, 1566In addition to the default foreground and background colours,
1408B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1567B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1409high-intensity bold/blink versions of the same). Here is a list of the 1568high-intensity (potentially bold/blink) versions of the same, and 72 (or
1410colours with their names. 1569240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1570cube plus a 8 (24) colour greyscale ramp.
1571
1572B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1573C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1574number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1575colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
157624-bit colour space. When indexing collisions happen, the nearest old colour in
1577the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1578use many similar 24-bit colours. It's typically not a problem in common
1579scenarios.
1580
1581Here is a list of the ANSI colours with their names.
1411 1582
1412=begin table 1583=begin table
1413 1584
1414 B<color0> (black) = Black 1585 B<color0> (black) = Black
1415 B<color1> (red) = Red3 1586 B<color1> (red) = Red3
1435It is also possible to specify the colour values of B<foreground>, 1606It is also possible to specify the colour values of B<foreground>,
1436B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1607B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1437a number 0-15, as a convenient shorthand to reference the colour name of 1608a number 0-15, as a convenient shorthand to reference the colour name of
1438color0-color15. 1609color0-color15.
1439 1610
1440In addition to the colours defined above, @@RXVT_NAME@@ offers an 1611The following text gives values for the standard 88 colour mode (and
1441additional 72 colours. The first 64 of those (with indices 16 to 79) 1612values for the 256 colour mode in parentheses).
1442consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144316>), followed by 8 additional shades of gray (with indices 80 to 87).
1444 1613
1614The RGB cube uses indices 16..79 (16..231) using the following formulas:
1615
1616 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1617 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1618
1619The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1620steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1621the RGB cube.
1622
1445Together, all those colours implement the 88 colour xterm colours. Only 1623Together, all those colours implement the 88 (256) colour xterm
1446the first 16 can be changed using resources currently, the rest can only 1624colours. Only the first 16 can be changed using resources currently, the
1447be changed via command sequences ("escape codes"). 1625rest can only be changed via command sequences ("escape codes").
1626
1627Applications are advised to use terminfo or command sequences to discover
1628number and RGB values of all colours (yes, you can query this...).
1448 1629
1449Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1630Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1450always swapping the foreground/background colours. This is in contrast to 1631always swapping the foreground/background colours. This is in contrast to
1451I<xterm>(1) where the colours are only swapped if they have not otherwise 1632I<xterm>(1) where the colours are only swapped if they have not otherwise
1452been specified. For example, 1633been specified. For example,
1453 1634
1454=over 4
1455
1456=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1635 @@RXVT_NAME@@ -fg Black -bg White -rv
1457 1636
1458would yield White on Black, while on I<xterm>(1) it would yield Black 1637would yield White on Black, while on I<xterm>(1) it would yield Black on
1459on White. 1638White.
1460
1461=back
1462 1639
1463=head2 ALPHA CHANNEL SUPPORT 1640=head2 ALPHA CHANNEL SUPPORT
1464 1641
1465If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1642If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1466their act together, rxvt-unicode will do it's own alpha channel management: 1643their act together, rxvt-unicode will do its own alpha channel management:
1467 1644
1468You can prefix any color with an opaquenes percentage enclosed in 1645You can prefix any colour with an opaqueness percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1646brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely 1647(0-100) that specifies the opacity of the colour, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a 1648transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1649half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with 1650is the recommended format to specify transparency values, and works with
1474all ways to specify a colour. 1651all ways to specify a colour.
1475 1652
1508 1685
1509=head1 ENVIRONMENT 1686=head1 ENVIRONMENT
1510 1687
1511B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1688B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1512 1689
1513=over 4 1690=over
1514 1691
1515=item B<TERM> 1692=item B<TERM>
1516 1693
1517Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1694Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1518resources or on the command line. 1695resources or on the command line.
1546C<--with-terminfo=PATH>. 1723C<--with-terminfo=PATH>.
1547 1724
1548=item B<DISPLAY> 1725=item B<DISPLAY>
1549 1726
1550Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1727Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1551display in its child processes. 1728display in its child processes if C<-display> isn't used to override. It
1729defaults to C<:0> if it doesn't exist.
1552 1730
1553=item B<SHELL> 1731=item B<SHELL>
1554 1732
1555The shell to be used for command execution, defaults to C</bin/sh>. 1733The shell to be used for command execution, defaults to C</bin/sh>.
1556 1734
1557=item B<RXVT_SOCKET> 1735=item B<RXVT_SOCKET> [I<sic>]
1558 1736
1559The unix domain socket path used by @@RXVT_NAME@@c(1) and 1737The unix domain socket path used by @@RXVT_NAME@@c(1) and
1560@@RXVT_NAME@@d(1). 1738@@RXVT_NAME@@d(1).
1561 1739
1562Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1740Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1741
1742=item B<URXVT_PERL_LIB>
1743
1744Additional F<:>-separated library search path for perl extensions. Will be
1745searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1746directory.
1747
1748=item B<URXVT_PERL_VERBOSITY>
1749
1750See L<@@RXVT_NAME@@perl>(3).
1563 1751
1564=item B<HOME> 1752=item B<HOME>
1565 1753
1566Used to locate the default directory for the unix domain socket for 1754Used to locate the default directory for the unix domain socket for
1567daemon communications and to locate various resource files (such as 1755daemon communications and to locate various resource files (such as
1568C<.Xdefaults>) 1756C<.Xdefaults>)
1569 1757
1570=item B<XAPPLRESDIR> 1758=item B<XAPPLRESDIR>
1571 1759
1572Directory where various X resource files are being located. 1760Directory where application-specific X resource files are located.
1573 1761
1574=item B<XENVIRONMENT> 1762=item B<XENVIRONMENT>
1575 1763
1576If set and accessible, gives the name of a X resource file to be loaded by 1764If set and accessible, gives the name of a X resource file to be loaded by
1577@@RXVT_NAME@@. 1765@@RXVT_NAME@@.
1578 1766
1579=back 1767=back
1580 1768
1581=head1 FILES 1769=head1 FILES
1582 1770
1583=over 4 1771=over
1584 1772
1585=item B</usr/lib/X11/rgb.txt> 1773=item B</usr/lib/X11/rgb.txt>
1586 1774
1587Color names. 1775Colour names.
1588 1776
1589=back 1777=back
1590 1778
1591=head1 SEE ALSO 1779=head1 SEE ALSO
1592 1780
1781@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1593@@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) 1782@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1594 1783
1595=head1 CURRENT PROJECT COORDINATOR 1784=head1 CURRENT PROJECT COORDINATOR
1596 1785
1597=over 4 1786=over
1598 1787
1599=item Project Coordinator 1788=item Project Coordinator
1600 1789
1601Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1790Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1602 1791
1603L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1792L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1604 1793
1605=back 1794=back
1606 1795
1607=head1 AUTHORS 1796=head1 AUTHORS
1608 1797
1609=over 4 1798=over
1610 1799
1611=item John Bovey 1800=item John Bovey
1612 1801
1613University of Kent, 1992, wrote the original Xvt. 1802University of Kent, 1992, wrote the original Xvt.
1614 1803
1615=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1804=item Rob Nation <nation@rocket.sanders.lockheed.com>
1616 1805
1617very heavily modified Xvt and came up with Rxvt 1806very heavily modified Xvt and came up with Rxvt
1618 1807
1619=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1808=item Angelo Haritsis <ah@doc.ic.ac.uk>
1620 1809
1621wrote the Greek Keyboard Input (no longer in code) 1810wrote the Greek Keyboard Input (no longer in code)
1622 1811
1623=item mj olesen L<< <olesen@me.QueensU.CA> >> 1812=item mj olesen <olesen@me.QueensU.CA>
1624 1813
1625Wrote the menu system. 1814Wrote the menu system.
1626 1815
1627Project Coordinator (changes.txt 2.11 to 2.21) 1816Project Coordinator (changes.txt 2.11 to 2.21)
1628 1817
1629=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1818=item Oezguer Kesim <kesim@math.fu-berlin.de>
1630 1819
1631Project Coordinator (changes.txt 2.21a to 2.4.5) 1820Project Coordinator (changes.txt 2.21a to 2.4.5)
1632 1821
1633=item Geoff Wing L<< <gcw@pobox.com> >> 1822=item Geoff Wing <gcw@pobox.com>
1634 1823
1635Rewrote screen display and text selection routines. 1824Rewrote screen display and text selection routines.
1636 1825
1637Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1826Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1638 1827
1639=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1828=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1640 1829
1641Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1830Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1642extension, random hacks, numerous bugfixes and extensions. 1831extension, random hacks, numerous bugfixes and extensions.
1643 1832
1644Project Coordinator (Changes 1.0 -) 1833Project Coordinator (Changes 1.0 -)
1645 1834
1646=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1835=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1647 1836
1648Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1837pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1649 1838
1650=back 1839=back
1651 1840

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines