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.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 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
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<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
535 538
536 # now communicate with rxvt 539 # now communicate with rxvt
537 my $slave = $pty->slave; 540 my $slave = $pty->slave;
538 while (<$slave>) { print $slave "got <$_>\n" } 541 while (<$slave>) { print $slave "got <$_>\n" }
539 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
540=item B<-pe> I<string> 560=item B<-pe> I<string>
541 561
542Comma-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
543this terminal instance. See resource B<perl-ext> for details. 563this terminal instance. See resource B<perl-ext> for details.
544 564
553You 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
554distribution do also load settings from the B<~/.Xresources> file when X 574distribution do also load settings from the B<~/.Xresources> file when X
555starts. @@RXVT_NAME@@ will consult the following files/resources in order, 575starts. @@RXVT_NAME@@ will consult the following files/resources in order,
556with later settings overwriting earlier ones: 576with later settings overwriting earlier ones:
557 577
558 1. system-wide app-defaults file, either locale-dependent OR global
559 2. app-defaults file in $XAPPLRESDIR 578 1. app-defaults file in $XAPPLRESDIR
579 2. $HOME/.Xdefaults
560 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 580 3. RESOURCE_MANAGER property on root-window of screen 0
561 4. SCREEN_RESOURCES for the current screen 581 4. SCREEN_RESOURCES property on root-window of the current screen
562 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 582 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
563 6. resources specified via -xrm on the commandline 583 6. resources specified via -xrm on the commandline
564 584
565Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 585Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
566names: 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
571be used. Command-line arguments can be used to override resource 591be used. Command-line arguments can be used to override resource
572settings. The following resources are supported (you might want to 592settings. The following resources are supported (you might want to
573check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 593check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
574extensions not documented here): 594extensions not documented here):
575 595
576=over 4 596=over
577 597
578=item B<depth:> I<bitdepth> 598=item B<depth:> I<bitdepth>
579 599
580Compile 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;
581option B<-depth>. 601option B<-depth>.
607Use 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
608corresponds to low-intensity (normal) colours and 8-15 corresponds to 628corresponds to low-intensity (normal) colours and 8-15 corresponds to
609high-intensity (bold = bright foreground, blink = bright background) 629high-intensity (bold = bright foreground, blink = bright background)
610colours. 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,
6113=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
612names used are listed in the B<COLORS AND GRAPHICS> section. 632names used are listed in the B<COLOURS AND GRAPHICS> section.
613 633
614Colours 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
615changed using an escape command (see @@RXVT_NAME@@(7)). 635changed using an escape command (see @@RXVT_NAME@@(7)).
616 636
617Colours 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
628=item B<colorUL:> I<colour> 648=item B<colorUL:> I<colour>
629 649
630Use the specified colour to display underlined characters when the 650Use the specified colour to display underlined characters when the
631foreground colour is the default. 651foreground colour is the default.
632 652
633=item B<colorRV:> I<colour>
634
635Use the specified colour as the background for reverse video characters
636when OPTION_HC is disabled (--disable-frills).
637
638=item B<underlineColor:> I<colour> 653=item B<underlineColor:> I<colour>
639 654
640If set, use the specified colour as the colour for the underline 655If set, use the specified colour as the colour for the underline
641itself. 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.
642 667
643=item B<cursorColor:> I<colour> 668=item B<cursorColor:> I<colour>
644 669
645Use 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
646foreground colour; option B<-cr>. 671foreground colour; option B<-cr>.
653 678
654=item B<reverseVideo:> I<boolean> 679=item B<reverseVideo:> I<boolean>
655 680
656B<True>: simulate reverse video by foreground and background colours; 681B<True>: simulate reverse video by foreground and background colours;
657option B<-rv>. B<False>: regular screen colours [default]; option 682option B<-rv>. B<False>: regular screen colours [default]; option
658B<+rv>. See note in B<COLORS AND GRAPHICS> section. 683B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
659 684
660=item B<jumpScroll:> I<boolean> 685=item B<jumpScroll:> I<boolean>
661 686
662B<True>: specify that jump scrolling should be used. When receiving lots 687B<True>: specify that jump scrolling should be used. When receiving lots
663of 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
677 702
678B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
679if 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
680monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
681 706
682=item B<transparent:> I<boolean> 707=item B<refreshRate:> I<number>
683 708
684Turn on/off illusion of a transparent window background. 709Compile I<frills>: When positive, sets the maximum refreshes per second
685 710(the default is C<60>). When zero or negative, sets the minimum interval
686B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 711between refreshes, negated. That is, positive numbers limit the number
687future versions. 712of refreshes per second to that number, similar to a fps limiter in
688 713games. Zero or negative numbers get negated and directly set the minimum
689I<Please address all transparency related issues to Sasha Vasko at 714interval between refreshs, that is, C<10> and C<-0.1> both specify the
690sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 715same refresh interval (likewise C<50> and C<0.02>). Fractional values are
716supported; option B<-fps>.
691 717
692=item B<fading:> I<number> 718=item B<fading:> I<number>
693 719
694Fade the text by the given percentage when focus is lost; option B<-fade>. 720Fade the text by the given percentage when focus is lost; option B<-fade>.
695 721
696=item B<fadeColor:> I<colour> 722=item B<fadeColor:> I<colour>
697 723
698Fade to this colour, when fading is used (see B<fading:>). The default 724Fade to this colour, when fading is used (see B<fading:>). The default
699colour is black; option B<-fadecolor>. 725colour is black; option B<-fadecolor>.
700 726
701=item B<tintColor:> I<colour> 727=item B<iconFile:> I<file>
702 728
703Tint the transparent background pixmap with the given colour; option 729Set the application icon pixmap; option B<-icon>.
704B<-tint>.
705
706=item B<shading:> I<number>
707
708Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
709in addition to tinting it; option B<-sh>.
710
711=item B<blendType:> I<string>
712
713Specify background blending type; option B<-blt>.
714
715=item B<blurRadius:> I<number>
716
717Apply Gaussian Blurr with the specified radius to the transparent
718background image; option B<-blr>.
719 730
720=item B<scrollColor:> I<colour> 731=item B<scrollColor:> I<colour>
721 732
722Use the specified colour for the scrollbar [default #B2B2B2]. 733Use the specified colour for the scrollbar [default #B2B2B2].
723 734
728 739
729=item B<borderColor:> I<colour> 740=item B<borderColor:> I<colour>
730 741
731The colour of the border around the text area and between the scrollbar 742The colour of the border around the text area and between the scrollbar
732and the text. 743and the text.
733
734=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
735
736Use the specified image file for the background and also
737optionally specify its scaling with a geometry string B<WxH+X+Y>,
738(default C<0x0+50+50>) in which B<"W" / "H"> specify the
739horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
740centre (percent). A scale of 0 displays the image with tiling. A scale
741of 1 displays the image without any scaling. A scale of 2 to 9 specifies
742an integer number of images in that direction. No image will be magnified
743beyond 10 times its original size. The maximum permitted scale is 1000.
744Additional operations can be specified after colon B<:op1:op2...>.
745Supported operations are:
746
747 tile force background image to be tiled and not scaled. Equivalent to 0x0
748 propscale will scale image keeping proportions
749 auto will scale image to match window size. Equivalent to 100x100
750 hscale will scale image horizontally to the window size
751 vscale will scale image vertically to the window size
752 scale will scale image to match window size
753 root will tile image as if it was a root window background, auto-adjusting
754 whenever terminal window moves
755
756If used in conjunction with B<-tr> option, the specified pixmap will be
757blended over transparency image using either alpha-blending, or any
758other blending type, specified with B<-blt "type"> option.
759
760=item B<path:> I<path>
761
762Specify the colon-delimited search path for finding background image files.
763 744
764=item B<font:> I<fontlist> 745=item B<font:> I<fontlist>
765 746
766Select the fonts to be used. This is a comma separated list of font names 747Select the fonts to be used. This is a comma separated list of font names
767that are checked in order when trying to find glyphs for characters. The 748that are checked in order when trying to find glyphs for characters. The
790it is named first) and thus defines the character cell grid to be 9 pixels 771it is named first) and thus defines the character cell grid to be 9 pixels
791wide and 15 pixels high. 772wide and 15 pixels high.
792 773
793The second font is just used to add additional unicode characters not in 774The second font is just used to add additional unicode characters not in
794the base font, likewise the third, which is unfortunately non-bold, but 775the base font, likewise the third, which is unfortunately non-bold, but
795the bold version of the font does contain less characters, so this is a 776the bold version of the font does contain fewer characters, so this is a
796useful supplement. 777useful supplement.
797 778
798The third font is an Xft font with aliasing turned off, and the characters 779The third font is an Xft font with aliasing turned off, and the characters
799are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 780are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
800contains other characters, but we are not interested in them. 781contains other characters, but we are not interested in them.
851=item B<urgentOnBell:> I<boolean> 832=item B<urgentOnBell:> I<boolean>
852 833
853B<True>: set the urgency hint for the wm on receipt of a bell character. 834B<True>: set the urgency hint for the wm on receipt of a bell character.
854B<False>: do not set the urgency hint [default]. 835B<False>: do not set the urgency hint [default].
855 836
837@@RXVT_NAME@@ resets the urgency hint on every focus change.
838
856=item B<visualBell:> I<boolean> 839=item B<visualBell:> I<boolean>
857 840
858B<True>: use visual bell on receipt of a bell character; option B<-vb>. 841B<True>: use visual bell on receipt of a bell character; option B<-vb>.
859B<False>: no visual bell [default]; option B<+vb>. 842B<False>: no visual bell [default]; option B<+vb>.
860 843
862 845
863B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 846B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
864the shell; option B<-ls>. B<False>: start as a normal sub-shell 847the shell; option B<-ls>. B<False>: start as a normal sub-shell
865[default]; option B<+ls>. 848[default]; option B<+ls>.
866 849
850=item B<multiClickTime:> I<number>
851
852Specify the maximum time in milliseconds between multi-click select
853events. The default is 500 milliseconds; option B<-mc>.
854
867=item B<utmpInhibit:> I<boolean> 855=item B<utmpInhibit:> I<boolean>
868 856
869B<True>: inhibit writing record into the system log file B<utmp>; 857B<True>: inhibit writing record into the system log file B<utmp>;
870option B<-ut>. B<False>: write record into the system log file B<utmp> 858option B<-ut>. B<False>: write record into the system log file B<utmp>
871[default]; option B<+ut>. 859[default]; option B<+ut>.
888=item B<scrollstyle:> I<mode> 876=item B<scrollstyle:> I<mode>
889 877
890Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 878Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891the author's favourite. 879the author's favourite.
892 880
881=item B<thickness:> I<number>
882
883Set the scrollbar width in pixels.
884
893=item B<scrollBar:> I<boolean> 885=item B<scrollBar:> I<boolean>
894 886
895B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 887B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
896disable the scrollbar; option B<+sb>. 888disable the scrollbar; option B<+sb>.
897 889
916B<False>: do not scroll to bottom when tty receives output; option 908B<False>: do not scroll to bottom when tty receives output; option
917B<+si>. 909B<+si>.
918 910
919=item B<scrollWithBuffer:> I<boolean> 911=item B<scrollWithBuffer:> I<boolean>
920 912
921B<True>: scroll with scrollback buffer when tty receives new lines (and 913B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
922B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 914try to show the same lines) and B<scrollTtyOutput> is False; option
923with scrollback buffer when tty receives new lines; option B<+sw>. 915B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
916new lines; option B<+sw>.
924 917
925=item B<scrollTtyKeypress:> I<boolean> 918=item B<scrollTtyKeypress:> I<boolean>
926 919
927B<True>: scroll to bottom when a non-special key is pressed. Special keys 920B<True>: scroll to bottom when a non-special key is pressed. Special keys
928are those which are intercepted by rxvt-unicode for special handling and 921are those which are intercepted by rxvt-unicode for special handling and
929are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 922are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
930bottom when a non-special key is pressed; option B<+sk>. 923bottom when a non-special key is pressed; option B<+sk>.
931 924
932=item B<saveLines:> I<number> 925=item B<saveLines:> I<number>
933 926
934Save I<number> lines in the scrollback buffer [default 64]. This 927Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
935resource is limited on most machines to 65535; option B<-sl>.
936 928
937=item B<internalBorder:> I<number> 929=item B<internalBorder:> I<number>
938 930
939Internal border of I<number> pixels. This resource is limited to 100; 931Internal border of I<number> pixels. This resource is limited to 100;
940option B<-b>. 932option B<-b>.
984=item B<cursorBlink:> I<boolean> 976=item B<cursorBlink:> I<boolean>
985 977
986B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 978B<True>: blink the cursor. B<False>: do not blink the cursor [default];
987option B<-bc>. 979option B<-bc>.
988 980
981=item B<cursorUnderline:> I<boolean>
982
983B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
984option B<-uc>.
985
989=item B<pointerBlank:> I<boolean> 986=item B<pointerBlank:> I<boolean>
990 987
991B<True>: blank the pointer when a key is pressed or after a set number 988B<True>: blank the pointer when a key is pressed or after a set number
992of seconds of inactivity. B<False>: the pointer is always visible 989of seconds of inactivity. B<False>: the pointer is always visible
993[default]. 990[default].
998 995
999=item B<pointerColor2:> I<colour> 996=item B<pointerColor2:> I<colour>
1000 997
1001Mouse pointer background colour. 998Mouse pointer background colour.
1002 999
1000=item B<pointerShape:> I<string>
1001
1002Compile I<frills>: Specifies the name of the mouse pointer shape
1003[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
1004file for possible values (omit the C<XC_> prefix).
1005
1003=item B<pointerBlankDelay:> I<number> 1006=item B<pointerBlankDelay:> I<number>
1004 1007
1005Specifies number of seconds before blanking the pointer [default 2]. Use a 1008Specifies number of seconds before blanking the pointer [default 2]. Use a
1006large number (e.g. C<987654321>) to effectively disable the timeout. 1009large number (e.g. C<987654321>) to effectively disable the timeout.
1007 1010
1008=item B<backspacekey:> I<string> 1011=item B<backspacekey:> I<string>
1009 1012
1010The string to send when the backspace key is pressed. If set to B<DEC> 1013The string to send when the backspace key is pressed. If set to B<DEC>
1011or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1014or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1012(code 8) - which can be reversed with the appropriate DEC private mode 1015(code 8) - which can be reversed with the appropriate DEC private mode
1013escape sequence. 1016escape sequence.
1014 1017
1015=item B<deletekey:> I<string> 1018=item B<deletekey:> I<string>
1016 1019
1033 1036
1034B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1037B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1035 1038
1036=item B<preeditType:> I<style> 1039=item B<preeditType:> I<style>
1037 1040
1038B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1041B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1039 1042
1040=item B<inputMethod:> I<name> 1043=item B<inputMethod:> I<name>
1041 1044
1042I<name> of inputMethod to use; option B<-im>. 1045I<name> of inputMethod to use; option B<-im>.
1043 1046
1061 1064
1062Change the meaning of triple-click selection with the left mouse 1065Change the meaning of triple-click selection with the left mouse
1063button. Instead of selecting a full line it will extend the selection to 1066button. Instead of selecting a full line it will extend the selection to
1064the end of the logical line only; option B<-tcw>. 1067the end of the logical line only; option B<-tcw>.
1065 1068
1069=item B<disablePasteBrackets:> I<boolean>
1070
1071Prevent emission of paste bracket sequences; option B<-dpb>.
1072
1066=item B<insecure:> I<boolean> 1073=item B<insecure:> I<boolean>
1067 1074
1068Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1075Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1069echo arbitrary strings like the icon name or the locale. This could be 1076echo arbitrary strings like the icon name or the locale. This could be
1070abused if somebody gets 8-bit-clean access to your display, whether 1077abused if somebody gets 8-bit-clean access to your display, whether
1071through a mail client displaying mail bodies unfiltered or through 1078through a mail client displaying mail bodies unfiltered or through
1072write(1) or any other means. Therefore, these sequences are disabled by 1079write(1) or any other means. Therefore, these sequences are disabled by
1073default. (Note that many other terminals, including xterm, have these 1080default. (Note that many other terminals, including xterm, have these
1091 1098
1092=item B<secondaryScreen:> I<boolean> 1099=item B<secondaryScreen:> I<boolean>
1093 1100
1094Turn on/off secondary screen (default enabled). 1101Turn on/off secondary screen (default enabled).
1095 1102
1103=item B<rewrapMode:> I<mode>
1104
1105Sets long line rewrap behaviour on window resize to one of B<auto>
1106(default), B<always> or B<never>.
1107
1096=item B<secondaryScroll:> I<boolean> 1108=item B<secondaryScroll:> I<boolean>
1097 1109
1098Turn on/off secondary screen scroll (default enabled). If this 1110Turn on/off secondary screen scroll (default enabled). If this
1099option is enabled, scrolls on the secondary screen will change the 1111option is enabled, scrolls on the secondary screen will change the
1100scrollback buffer and, when secondaryScreen is off, switching 1112scrollback buffer and, when secondaryScreen is off, switching
1112Sets the working directory for the shell (or the command specified via 1124Sets the working directory for the shell (or the command specified via
1113B<-e>). The I<path> must be an absolute path and it must exist for 1125B<-e>). The I<path> must be an absolute path and it must exist for
1114@@RXVT_NAME@@ to start. If it isn't specified then the current working 1126@@RXVT_NAME@@ to start. If it isn't specified then the current working
1115directory will be used; option B<-cd>. 1127directory will be used; option B<-cd>.
1116 1128
1117=item B<keysym.>I<sym>: I<string> 1129=item B<keysym.>I<sym>: I<action>
1118 1130
1119Compile I<frills>: Associate I<string> with keysym I<sym>. The 1131Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1120intervening resource name B<keysym.> cannot be omitted. 1132resource name B<keysym.> cannot be omitted.
1121 1133
1122The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1134Using this resource, you can map key combinations such as
1123any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1135C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1124B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1136string than would normally result from that combination, making the
1125and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1137terminal scroll up or down the way you want it, or any other thing an
1126B<2>, B<3>, B<4>, B<5>. 1138extension might provide.
1139
1140The key combination that triggers the action, I<sym>, has the following format:
1141
1142 (modifiers-)key
1143
1144Where I<modifiers> can be any combination of the following full or
1145abbreviated modifier names:
1146
1147=begin table
1148
1149 B<ISOLevel3> B<I>
1150 B<AppKeypad> B<K>
1151 B<Control> B<C>
1152 B<NumLock> B<N>
1153 B<Shift> B<S>
1154 B<Meta> B<M> I<or> B<A>
1155 B<Lock> B<L>
1156 B<Mod1> B<1>
1157 B<Mod2> B<2>
1158 B<Mod3> B<3>
1159 B<Mod4> B<4>
1160 B<Mod5> B<5>
1161
1162=end table
1127 1163
1128The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1164The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1129whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1165whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1130keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1166keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1131current application keymap mode state. 1167current application keymap mode state.
1132 1168
1133The spellings of I<key> can be obtained by using B<xev>(1) command or 1169Due the the large number of modifier combinations, a key mapping will
1134searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1170match if I<at least> the specified identifiers are being set, and no other
1171key mappings with those and more bits are being defined. That means that
1172defining a mapping for C<a> will automatically provide definitions for
1173C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1174themselves. See the C<builtin:> action, below, for a way to work around
1175this when this is a problem.
1176
1177The spelling of I<key> depends on your implementation of X. An easy way to
1178find a key name is to use the B<xev>(1) command. You can find a list by
1179looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1135omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1180the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1136keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1181value (B<0x0000 - 0xFFFF>).
1137performed in an exact manner; however, the closest match is assured.
1138 1182
1139I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1183As with any resource value, the I<action> string may contain backslash
1184escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1140number), see RESOURCES in C<man 7 X> for futher details. 1185number), see RESOURCES in C<man 7 X> for further details.
1141 1186
1142You can define a range of keysyms in one shot by providing a I<string> 1187An action starts with an action prefix that selects a certain type
1143with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1188of action, followed by a colon. An action string without colons is
1189interpreted as a literal string to pass to the tty (as if it was
1190prefixed with C<string:>).
1191
1192The following action prefixes are known - extensions can provide
1193additional prefixes:
1194
1195=over
1196
1197=item string:STRING
1198
1199If the I<action> starts with C<string:> (or otherwise contains no colons),
1200then the remaining C<STRING> will be passed to the program running in the
1201terminal. For example, you could replace whatever Shift-Tab outputs by the
1202string C<echo rm -rf /> followed by a newline:
1203
1204 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1205
1206This could in theory be used to completely redefine your keymap.
1207
1208In addition, for actions of this type, you can define a range of
1209keysyms in one shot by loading the C<keysym-list> perl extension and
1210providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1144should be a character not used by the strings. 1211the delimiter `/' should be a character not used by the strings.
1145 1212
1146Its usage can be demonstrated by an example: 1213Its usage can be demonstrated by an example:
1147 1214
1148 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1215 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1149 1216
1150The above line is equivalent to the following three lines: 1217The above line is equivalent to the following three lines:
1151 1218
1152 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1219 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1153 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1220 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1154 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1221 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1155 1222
1223=item command:STRING
1224
1156If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1225If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1157is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1227the opposite of C<string:> - instead of sending it to the program running
1228in the terminal, it will be treated as if it were program output). This is
1229most useful to feed command sequences into @@RXVT_NAME@@.
1230
1158example the following means "change the current locale to C<zh_CN.GBK> 1231For example the following means "change the current locale to C<zh_CN.GBK>
1159when Control-Meta-c is being pressed": 1232when Control-Meta-c is being pressed":
1160 1233
1161 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1234 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1162 1235
1163If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1236The following example will map Control-Meta-1 and Control-Meta-2 to
1164is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1237the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1165manpage. For example, the F<selection> extension (activated via 1238font-switching at runtime:
1166C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1167 1239
1168 URxvt.keysym.M-C-c: perl:selection:rot13 1240 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1241 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1169 1242
1170Due the the large number of modifier combinations, a defined key mapping 1243Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1171will match if at I<at least> the specified identifiers are being set, and 1244info):
1172no other key mappings with those and more bits are being defined. That
1173means that defining a key map for C<a> will automatically provide
1174definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1175mappings themselves.
1176 1245
1177Unfortunately, this will override built-in key mappings. For example 1246 URxvt.keysym.M-C-3: command:\033[8;25;80t
1247 URxvt.keysym.M-C-4: command:\033[8;48;110t
1248
1249=item builtin:
1250
1251The builtin action is the action that @@RXVT_NAME@@ would execute if no
1252key binding existed for the key combination. The obvious use is to undo
1253the effect of existing bindings. The not so obvious use is to reinstate
1254bindings when another binding overrides too many modifiers.
1255
1178if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1256For example if you overwrite the C<Insert> key you will disable
1179C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1257@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1180user-defined keymap using the C<builtin:> replacement: 1258"holes" into the user-defined keymap using the C<builtin:> replacement:
1181 1259
1182 URxvt.keysym.Insert: <my insert key sequence> 1260 URxvt.keysym.Insert: <my insert key sequence>
1183 URxvt.keysym.S-Insert: builtin: 1261 URxvt.keysym.S-Insert: builtin:
1184 1262
1185The first line defines a mapping for C<Insert> and I<any> combination 1263The first line defines a mapping for C<Insert> and I<any> combination
1186of modifiers. The second line re-establishes the default mapping for 1264of modifiers. The second line re-establishes the default mapping for
1187C<Shift-Insert>. 1265C<Shift-Insert>.
1188 1266
1189The following example will map Control-Meta-1 and Control-Meta-2 to 1267=item builtin-string:
1190the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1191font-switching at runtime:
1192 1268
1193 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1269This action is mainly useful to restore string mappings for keys that
1194 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1270have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1271difficult to explain - basically, this action will send the string to the
1272application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1273action for it.
1195 1274
1196Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1275An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1197info): 1276selection when you press C<Shift-Insert>. With the following bindings, it
1277would instead emit the (undocumented, but what applications running in the
1278terminal might expect) sequence C<ESC [ 2 $> instead:
1198 1279
1199 URxvt.keysym.M-C-3: command:\033[8;25;80t 1280 URxvt.keysym.S-Insert: builtin-string:
1200 URxvt.keysym.M-C-4: command:\033[8;48;110t 1281 URxvt.keysym.C-S-Insert: builtin:
1282
1283The first line disables the paste functionality for that key
1284combination, and the second reinstates the default behaviour for
1285C<Control-Shift-Insert>, which would otherwise be overridden.
1286
1287Similarly, to let applications gain access to the C<C-M-c> (copy to
1288clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1289this:
1290
1291 URxvt.keysym.C-M-c: builtin-string:
1292 URxvt.keysym.C-M-v: builtin-string:
1293
1294=item EXTENSION:STRING
1295
1296An action of this form invokes the action B<STRING>, if any, provided
1297by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1298be loaded automatically if necessary.
1299
1300Not all extensions define actions, but popular extensions that do
1301include the I<selection> and I<matcher> extensions (documented in their
1302own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1303respectively).
1304
1305From the silly examples department, this will rot13-"encrypt"
1306@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1307keyboards:
1308
1309 URxvt.keysym.M-C-c: selection:rot13
1310
1311=item perl:STRING *DEPRECATED*
1312
1313This is a deprecated way of invoking commands provided by perl
1314extensions. It is still supported, but should not be used anymore.
1315
1316=back
1201 1317
1202=item B<perl-ext-common>: I<string> 1318=item B<perl-ext-common>: I<string>
1203 1319
1204=item B<perl-ext>: I<string> 1320=item B<perl-ext>: I<string>
1205 1321
1206Comma-separated list(s) of perl extension scripts (default: C<default>) to 1322Comma-separated list(s) of perl extension scripts (default: C<default>) to
1207use in this terminal instance; option B<-pe>. 1323use in this terminal instance; option B<-pe>.
1208 1324
1209Extension names can be prefixed with a C<-> sign to prohibit using 1325Extension names can be prefixed with a C<-> sign to remove them again, in
1210them. This can be useful to selectively disable some extensions loaded 1326case they had been specified earlier. This can be useful to selectively
1211by default, or specified via the C<perl-ext-common> resource. For 1327disable some extensions loaded by default, or specified via the
1212example, C<default,-selection> will use all the default extension except 1328C<perl-ext-common> resource. For example, C<default,-selection> will use
1213C<selection>. 1329all the default extensions except C<selection>.
1214 1330
1215Extension names can also be followed by an argument in angle brackets 1331To prohibit autoloading of extensions, you can prefix them with C</>,
1216(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1332which will make urxvt refuse to automatically load them (this can be
1217searchable scrollback to Alt/Meta-s). Mentioning the same extension 1333overridden, however, by specifying the extension name again without a
1218multiple times with different arguments will pass multiple arguments to 1334prefix, though). This does not prohibit extensions themselves loading
1219the extension. 1335other extensions. For example, C<default,/background> will keep the
1336C<background> extension from being loaded when a background OSC sequence
1337is received.
1338
1339The default set includes the C<selection>, C<option-popup>,
1340C<selection-popup>, C<readline>, C<searchable-scrollback> and
1341C<confirm-paste> extensions, as well as any extensions which are mentioned
1342in B<keysym> resources.
1343
1344Any extension such that a corresponding resource is given on the
1345command line is automatically appended to B<perl-ext>.
1220 1346
1221Each extension is looked up in the library directories, loaded if 1347Each extension is looked up in the library directories, loaded if
1222necessary, and bound to the current terminal instance. 1348necessary, and bound to the current terminal instance. When the library
1349search path contains multiple extension files of the same name, then the
1350first one found will be used.
1223 1351
1224If both of these resources are the empty string, then the perl 1352If both of these resources are the empty string, then the perl interpreter
1225interpreter will not be initialized. The idea behind two options is that 1353will not be initialized. The rationale for having two options is that
1226B<perl-ext-common> will be used for extensions that should be available to 1354B<perl-ext-common> will be used for extensions that should be available to
1227all instances, while B<perl-ext> is used for specific instances. 1355all instances, while B<perl-ext> is used for specific instances.
1228 1356
1229=item B<perl-eval>: I<string> 1357=item B<perl-eval>: I<string>
1230 1358
1231Perl code to be evaluated when all extensions have been registered. See 1359Perl code to be evaluated when all extensions have been registered. See
1232the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1360the @@RXVT_NAME@@perl(3) manpage.
1233will be ignored when running setuid/setgid.
1234 1361
1235=item B<perl-lib>: I<path> 1362=item B<perl-lib>: I<path>
1236 1363
1237Colon-separated list of additional directories that hold extension 1364Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource, 1365scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1239@@RXVT_NAME@@ will first look in these directories and then in 1366in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1367lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241will be ignored when running setuid/setgid.
1242 1368
1243See the @@RXVT_NAME@@perl(3) manpage. 1369See the @@RXVT_NAME@@perl(3) manpage.
1244 1370
1245=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1371=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1246 1372
1250=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1376=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1251 1377
1252Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1378Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1253for details. 1379for details.
1254 1380
1255=item B<searchable-scrollback:> I<keysym> 1381=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1256 1382
1257Sets the hotkey that starts the incremental scrollback buffer search 1383This resource is deprecated and will be removed. Use a B<keysym> resource
1258(default: C<M-s>). 1384instead, e.g.:
1259 1385
1386 URxvt.keysym.M-s: searchable-scrollback:start
1387
1260=item B<urlLauncher>: I<string> 1388=item B<url-launcher>: I<string>
1261 1389
1262Specifies the program to be started with a URL argument. Used by the 1390Specifies the program to be started with a URL argument. Used by the
1263C<selection-popup> and C<matcher> perl extensions. 1391C<selection-popup> and C<matcher> perl extensions.
1264 1392
1265=item B<transient-for>: I<windowid> 1393=item B<transient-for>: I<windowid>
1268 1396
1269=item B<override-redirect>: I<boolean> 1397=item B<override-redirect>: I<boolean>
1270 1398
1271Compile I<frills>: Sets override-redirect for the terminal window, making 1399Compile I<frills>: Sets override-redirect for the terminal window, making
1272it almost invisible to window managers; option B<-override-redirect>. 1400it almost invisible to window managers; option B<-override-redirect>.
1401
1402=item B<iso14755:> I<boolean>
1403
1404Turn on/off ISO 14755 (default enabled).
1273 1405
1274=item B<iso14755_52:> I<boolean> 1406=item B<iso14755_52:> I<boolean>
1275 1407
1276Turn on/off ISO 14755 5.2 mode (default enabled). 1408Turn on/off ISO 14755 5.2 mode (default enabled).
1277 1409
1305=head1 THE SELECTION: SELECTING AND PASTING TEXT 1437=head1 THE SELECTION: SELECTING AND PASTING TEXT
1306 1438
1307The behaviour of text selection and insertion/pasting mechanism is similar 1439The behaviour of text selection and insertion/pasting mechanism is similar
1308to I<xterm>(1). 1440to I<xterm>(1).
1309 1441
1310=over 4 1442=over
1311 1443
1312=item B<Selecting>: 1444=item B<Selecting>:
1313 1445
1314Left click at the beginning of the region, drag to the end of the region 1446Left click at the beginning of the region, drag to the end of the region
1315and release; Right click to extend the marked region; Left double-click 1447and release; Right click to extend the marked region; Left double-click
1330B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1462B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1331 1463
1332Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1464Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1333inserted too. 1465inserted too.
1334 1466
1467rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1468<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1469binding causes the value of the internal selection to be copied to the
1470CLIPBOARD selection, while the second binding causes the value of the
1471CLIPBOARD selection to be inserted.
1472
1335=back 1473=back
1336 1474
1337=head1 CHANGING FONTS 1475=head1 CHANGING FONTS
1338 1476
1339Changing fonts (or font sizes, respectively) via the keypad is not yet 1477Changing fonts (or font sizes, respectively) via the keypad is not yet
1356and character codes using the keyboard. It consists of 4 parts. The 1494and character codes using the keyboard. It consists of 4 parts. The
1357first part is available if rxvt-unicode has been compiled with 1495first part is available if rxvt-unicode has been compiled with
1358C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1496C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1359with C<--enable-iso14755>. 1497with C<--enable-iso14755>.
1360 1498
1361=over 4 1499=over
1362 1500
1363=item * 5.1: Basic method 1501=item * 5.1: Basic method
1364 1502
1365This allows you to enter unicode characters using their hexcode. 1503This allows you to enter unicode characters using their hexcode.
1366 1504
1420B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1558B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1421it can be seen via the I<who(1)> command, and can accept messages. To 1559it can be seen via the I<who(1)> command, and can accept messages. To
1422allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1560allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1423on some systems or setgid to root or to some other group on others. 1561on some systems or setgid to root or to some other group on others.
1424 1562
1425=head1 COLORS AND GRAPHICS 1563=head1 COLOURS AND GRAPHICS
1426 1564
1427In addition to the default foreground and background colours, 1565In addition to the default foreground and background colours,
1428B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1566B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1429high-intensity bold/blink versions of the same). Here is a list of the 1567high-intensity (potentially bold/blink) versions of the same, and 72 (or
1430colours with their names. 1568240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1569cube plus a 8 (24) colour greyscale ramp.
1570
1571B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1572C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1573number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1574colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
157524-bit colour space. When indexing collisions happen, the nearest old colour in
1576the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1577use many similar 24-bit colours. It's typically not a problem in common
1578scenarios.
1579
1580Here is a list of the ANSI colours with their names.
1431 1581
1432=begin table 1582=begin table
1433 1583
1434 B<color0> (black) = Black 1584 B<color0> (black) = Black
1435 B<color1> (red) = Red3 1585 B<color1> (red) = Red3
1455It is also possible to specify the colour values of B<foreground>, 1605It is also possible to specify the colour values of B<foreground>,
1456B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1606B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1457a number 0-15, as a convenient shorthand to reference the colour name of 1607a number 0-15, as a convenient shorthand to reference the colour name of
1458color0-color15. 1608color0-color15.
1459 1609
1460In addition to the colours defined above, @@RXVT_NAME@@ offers an 1610The following text gives values for the standard 88 colour mode (and
1461additional 72 colours. The first 64 of those (with indices 16 to 79) 1611values for the 256 colour mode in parentheses).
1462consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146316>), followed by 8 additional shades of gray (with indices 80 to 87).
1464 1612
1613The RGB cube uses indices 16..79 (16..231) using the following formulas:
1614
1615 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1616 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1617
1618The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1619steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1620the RGB cube.
1621
1465Together, all those colours implement the 88 colour xterm colours. Only 1622Together, all those colours implement the 88 (256) colour xterm
1466the first 16 can be changed using resources currently, the rest can only 1623colours. Only the first 16 can be changed using resources currently, the
1467be changed via command sequences ("escape codes"). 1624rest can only be changed via command sequences ("escape codes").
1625
1626Applications are advised to use terminfo or command sequences to discover
1627number and RGB values of all colours (yes, you can query this...).
1468 1628
1469Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1629Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1470always swapping the foreground/background colours. This is in contrast to 1630always swapping the foreground/background colours. This is in contrast to
1471I<xterm>(1) where the colours are only swapped if they have not otherwise 1631I<xterm>(1) where the colours are only swapped if they have not otherwise
1472been specified. For example, 1632been specified. For example,
1473 1633
1474=over 4
1475
1476=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1634 @@RXVT_NAME@@ -fg Black -bg White -rv
1477 1635
1478would yield White on Black, while on I<xterm>(1) it would yield Black 1636would yield White on Black, while on I<xterm>(1) it would yield Black on
1479on White. 1637White.
1480
1481=back
1482 1638
1483=head2 ALPHA CHANNEL SUPPORT 1639=head2 ALPHA CHANNEL SUPPORT
1484 1640
1485If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1641If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1486their act together, rxvt-unicode will do it's own alpha channel management: 1642their act together, rxvt-unicode will do its own alpha channel management:
1487 1643
1488You can prefix any color with an opaquenes percentage enclosed in 1644You can prefix any colour with an opaqueness percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1645brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490(0-100) that specifies the opacity of the color, where C<0> is completely 1646(0-100) that specifies the opacity of the colour, where C<0> is completely
1491transparent and C<100> is completely opaque. For example, C<[50]red> is a 1647transparent and C<100> is completely opaque. For example, C<[50]red> is a
1492half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1648half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493is the recommended format to specify transparency values, and works with 1649is the recommended format to specify transparency values, and works with
1494all ways to specify a colour. 1650all ways to specify a colour.
1495 1651
1528 1684
1529=head1 ENVIRONMENT 1685=head1 ENVIRONMENT
1530 1686
1531B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1687B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1532 1688
1533=over 4 1689=over
1534 1690
1535=item B<TERM> 1691=item B<TERM>
1536 1692
1537Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1693Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1538resources or on the command line. 1694resources or on the command line.
1573 1729
1574=item B<SHELL> 1730=item B<SHELL>
1575 1731
1576The shell to be used for command execution, defaults to C</bin/sh>. 1732The shell to be used for command execution, defaults to C</bin/sh>.
1577 1733
1578=item B<RXVT_SOCKET> 1734=item B<RXVT_SOCKET> [I<sic>]
1579 1735
1580The unix domain socket path used by @@RXVT_NAME@@c(1) and 1736The unix domain socket path used by @@RXVT_NAME@@c(1) and
1581@@RXVT_NAME@@d(1). 1737@@RXVT_NAME@@d(1).
1582 1738
1583Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1739Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1740
1741=item B<URXVT_PERL_LIB>
1742
1743Additional F<:>-separated library search path for perl extensions. Will be
1744searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1745directory.
1746
1747=item B<URXVT_PERL_VERBOSITY>
1748
1749See L<@@RXVT_NAME@@perl>(3).
1584 1750
1585=item B<HOME> 1751=item B<HOME>
1586 1752
1587Used to locate the default directory for the unix domain socket for 1753Used to locate the default directory for the unix domain socket for
1588daemon communications and to locate various resource files (such as 1754daemon communications and to locate various resource files (such as
1589C<.Xdefaults>) 1755C<.Xdefaults>)
1590 1756
1591=item B<XAPPLRESDIR> 1757=item B<XAPPLRESDIR>
1592 1758
1593Directory where various X resource files are being located. 1759Directory where application-specific X resource files are located.
1594 1760
1595=item B<XENVIRONMENT> 1761=item B<XENVIRONMENT>
1596 1762
1597If set and accessible, gives the name of a X resource file to be loaded by 1763If set and accessible, gives the name of a X resource file to be loaded by
1598@@RXVT_NAME@@. 1764@@RXVT_NAME@@.
1599 1765
1600=back 1766=back
1601 1767
1602=head1 FILES 1768=head1 FILES
1603 1769
1604=over 4 1770=over
1605 1771
1606=item B</usr/lib/X11/rgb.txt> 1772=item B</usr/lib/X11/rgb.txt>
1607 1773
1608Color names. 1774Colour names.
1609 1775
1610=back 1776=back
1611 1777
1612=head1 SEE ALSO 1778=head1 SEE ALSO
1613 1779
1780@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1614@@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) 1781@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1615 1782
1616=head1 CURRENT PROJECT COORDINATOR 1783=head1 CURRENT PROJECT COORDINATOR
1617 1784
1618=over 4 1785=over
1619 1786
1620=item Project Coordinator 1787=item Project Coordinator
1621 1788
1622Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1789Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1623 1790
1624L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1791L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1625 1792
1626=back 1793=back
1627 1794
1628=head1 AUTHORS 1795=head1 AUTHORS
1629 1796
1630=over 4 1797=over
1631 1798
1632=item John Bovey 1799=item John Bovey
1633 1800
1634University of Kent, 1992, wrote the original Xvt. 1801University of Kent, 1992, wrote the original Xvt.
1635 1802
1636=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1803=item Rob Nation <nation@rocket.sanders.lockheed.com>
1637 1804
1638very heavily modified Xvt and came up with Rxvt 1805very heavily modified Xvt and came up with Rxvt
1639 1806
1640=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1807=item Angelo Haritsis <ah@doc.ic.ac.uk>
1641 1808
1642wrote the Greek Keyboard Input (no longer in code) 1809wrote the Greek Keyboard Input (no longer in code)
1643 1810
1644=item mj olesen L<< <olesen@me.QueensU.CA> >> 1811=item mj olesen <olesen@me.QueensU.CA>
1645 1812
1646Wrote the menu system. 1813Wrote the menu system.
1647 1814
1648Project Coordinator (changes.txt 2.11 to 2.21) 1815Project Coordinator (changes.txt 2.11 to 2.21)
1649 1816
1650=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1817=item Oezguer Kesim <kesim@math.fu-berlin.de>
1651 1818
1652Project Coordinator (changes.txt 2.21a to 2.4.5) 1819Project Coordinator (changes.txt 2.21a to 2.4.5)
1653 1820
1654=item Geoff Wing L<< <gcw@pobox.com> >> 1821=item Geoff Wing <gcw@pobox.com>
1655 1822
1656Rewrote screen display and text selection routines. 1823Rewrote screen display and text selection routines.
1657 1824
1658Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1825Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1659 1826
1660=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1827=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1661 1828
1662Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1829Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1663extension, random hacks, numerous bugfixes and extensions. 1830extension, random hacks, numerous bugfixes and extensions.
1664 1831
1665Project Coordinator (Changes 1.0 -) 1832Project Coordinator (Changes 1.0 -)
1666 1833
1667=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1834=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1668 1835
1669Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1836pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1670 1837
1671=back 1838=back
1672 1839

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines