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.162 by root, Fri May 16 19:27:16 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
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
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>.
601Use 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
602corresponds to low-intensity (normal) colours and 8-15 corresponds to 628corresponds to low-intensity (normal) colours and 8-15 corresponds to
603high-intensity (bold = bright foreground, blink = bright background) 629high-intensity (bold = bright foreground, blink = bright background)
604colours. 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,
6053=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
606names used are listed in the B<COLORS AND GRAPHICS> section. 632names used are listed in the B<COLOURS AND GRAPHICS> section.
607 633
608Colours 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
609changed using an escape command (see @@RXVT_NAME@@(7)). 635changed using an escape command (see @@RXVT_NAME@@(7)).
610 636
611Colours 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
622=item B<colorUL:> I<colour> 648=item B<colorUL:> I<colour>
623 649
624Use the specified colour to display underlined characters when the 650Use the specified colour to display underlined characters when the
625foreground colour is the default. 651foreground colour is the default.
626 652
627=item B<colorRV:> I<colour>
628
629Use the specified colour as the background for reverse video characters
630when OPTION_HC is disabled (--disable-frills).
631
632=item B<underlineColor:> I<colour> 653=item B<underlineColor:> I<colour>
633 654
634If set, use the specified colour as the colour for the underline 655If set, use the specified colour as the colour for the underline
635itself. 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.
636 667
637=item B<cursorColor:> I<colour> 668=item B<cursorColor:> I<colour>
638 669
639Use 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
640foreground colour; option B<-cr>. 671foreground colour; option B<-cr>.
647 678
648=item B<reverseVideo:> I<boolean> 679=item B<reverseVideo:> I<boolean>
649 680
650B<True>: simulate reverse video by foreground and background colours; 681B<True>: simulate reverse video by foreground and background colours;
651option B<-rv>. B<False>: regular screen colours [default]; option 682option B<-rv>. B<False>: regular screen colours [default]; option
652B<+rv>. See note in B<COLORS AND GRAPHICS> section. 683B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653 684
654=item B<jumpScroll:> I<boolean> 685=item B<jumpScroll:> I<boolean>
655 686
656B<True>: specify that jump scrolling should be used. When receiving lots 687B<True>: specify that jump scrolling should be used. When receiving lots
657of 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
671 702
672B<False>: specify that everything is to be displayed, even 703B<False>: specify that everything is to be displayed, even
673if 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
674monitor to display anything); option B<+ss>. 705monitor to display anything); option B<+ss>.
675 706
676=item B<transparent:> I<boolean> 707=item B<refreshRate:> I<number>
677 708
678Turn on/off illusion of a transparent window background. 709Compile I<frills>: When positive, sets the maximum refreshes per second
679 710(the default is C<60>). When zero or negative, sets the minimum interval
680B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 711between refreshes, negated. That is, positive numbers limit the number
681future versions. 712of refreshes per second to that number, similar to a fps limiter in
682 713games. A negative number gets negated and directly sets the minimum
683I<Please address all transparency related issues to Sasha Vasko at 714interval between refreshes, that is, C<10> and C<-0.1> both specify
684sasha@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>.
685 718
686=item B<fading:> I<number> 719=item B<fading:> I<number>
687 720
688Fade 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>.
689 722
690=item B<fadeColor:> I<colour> 723=item B<fadeColor:> I<colour>
691 724
692Fade 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
693colour is black; option B<-fadecolor>. 726colour is black; option B<-fadecolor>.
694 727
695=item B<tintColor:> I<colour> 728=item B<iconFile:> I<file>
696 729
697Tint the transparent background pixmap with the given colour; option 730Set the application icon pixmap; option B<-icon>.
698B<-tint>.
699
700=item B<shading:> I<number>
701
702Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
703in addition to tinting it; option B<-sh>.
704
705=item B<blendType:> I<string>
706
707Specify background blending type; option B<-blt>.
708
709=item B<blurRadius:> I<number>
710
711Apply Gaussian Blurr with the specified radius to the transparent
712background image; option B<-blr>.
713 731
714=item B<scrollColor:> I<colour> 732=item B<scrollColor:> I<colour>
715 733
716Use the specified colour for the scrollbar [default #B2B2B2]. 734Use the specified colour for the scrollbar [default #B2B2B2].
717 735
722 740
723=item B<borderColor:> I<colour> 741=item B<borderColor:> I<colour>
724 742
725The 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
726and the text. 744and the text.
727
728=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
729
730Use the specified image file for the background and also
731optionally specify its scaling with a geometry string B<WxH+X+Y>,
732(default C<0x0+50+50>) in which B<"W" / "H"> specify the
733horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
734centre (percent). A scale of 0 displays the image with tiling. A scale
735of 1 displays the image without any scaling. A scale of 2 to 9 specifies
736an integer number of images in that direction. No image will be magnified
737beyond 10 times its original size. The maximum permitted scale is 1000.
738Additional operations can be specified after colon B<:op1:op2...>.
739Supported operations are:
740
741 tile force background image to be tiled and not scaled. Equivalent to 0x0
742 propscale will scale image keeping proportions
743 auto will scale image to match window size. Equivalent to 100x100
744 hscale will scale image horizontally to the window size
745 vscale will scale image vertically to the window size
746 scale will scale image to match window size
747 root will tile image as if it was a root window background, auto-adjusting
748 whenever terminal window moves
749
750If used in conjunction with B<-tr> option, the specified pixmap will be
751blended over transparency image using either alpha-blending, or any
752other blending type, specified with B<-blt "type"> option.
753
754=item B<path:> I<path>
755
756Specify the colon-delimited search path for finding background image files.
757 745
758=item B<font:> I<fontlist> 746=item B<font:> I<fontlist>
759 747
760Select 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
761that 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
784it 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
785wide and 15 pixels high. 773wide and 15 pixels high.
786 774
787The 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
788the base font, likewise the third, which is unfortunately non-bold, but 776the base font, likewise the third, which is unfortunately non-bold, but
789the 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
790useful supplement. 778useful supplement.
791 779
792The 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
793are 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
794contains other characters, but we are not interested in them. 782contains other characters, but we are not interested in them.
845=item B<urgentOnBell:> I<boolean> 833=item B<urgentOnBell:> I<boolean>
846 834
847B<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.
848B<False>: do not set the urgency hint [default]. 836B<False>: do not set the urgency hint [default].
849 837
838@@RXVT_NAME@@ resets the urgency hint on every focus change.
839
850=item B<visualBell:> I<boolean> 840=item B<visualBell:> I<boolean>
851 841
852B<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>.
853B<False>: no visual bell [default]; option B<+vb>. 843B<False>: no visual bell [default]; option B<+vb>.
854 844
856 846
857B<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
858the 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
859[default]; option B<+ls>. 849[default]; option B<+ls>.
860 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
861=item B<utmpInhibit:> I<boolean> 856=item B<utmpInhibit:> I<boolean>
862 857
863B<True>: inhibit writing record into the system log file B<utmp>; 858B<True>: inhibit writing record into the system log file B<utmp>;
864option 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>
865[default]; option B<+ut>. 860[default]; option B<+ut>.
882=item B<scrollstyle:> I<mode> 877=item B<scrollstyle:> I<mode>
883 878
884Set 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
885the author's favourite. 880the author's favourite.
886 881
882=item B<thickness:> I<number>
883
884Set the scrollbar width in pixels.
885
887=item B<scrollBar:> I<boolean> 886=item B<scrollBar:> I<boolean>
888 887
889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 888B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
890disable the scrollbar; option B<+sb>. 889disable the scrollbar; option B<+sb>.
891 890
904Align 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
905thumb with the pointer on middle button press/drag. 904thumb with the pointer on middle button press/drag.
906 905
907=item B<scrollTtyOutput:> I<boolean> 906=item B<scrollTtyOutput:> I<boolean>
908 907
909B<True>: scroll to bottom when tty receives output; option B<-si>. 908B<True>: scroll to bottom when tty receives output; option B<+si>.
910B<False>: do not scroll to bottom when tty receives output; option 909B<False>: do not scroll to bottom when tty receives output; option
911B<+si>. 910B<-si>.
912 911
913=item B<scrollWithBuffer:> I<boolean> 912=item B<scrollWithBuffer:> I<boolean>
914 913
915B<True>: scroll with scrollback buffer when tty receives new lines (and 914B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
916B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 915try to show the same lines) and B<scrollTtyOutput> is False; option
917with 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>.
918 918
919=item B<scrollTtyKeypress:> I<boolean> 919=item B<scrollTtyKeypress:> I<boolean>
920 920
921B<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
922are those which are intercepted by rxvt-unicode for special handling and 922are those which are intercepted by rxvt-unicode for special handling and
923are 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
924bottom when a non-special key is pressed; option B<+sk>. 924bottom when a non-special key is pressed; option B<+sk>.
925 925
926=item B<saveLines:> I<number> 926=item B<saveLines:> I<number>
927 927
928Save I<number> lines in the scrollback buffer [default 64]. This 928Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
929resource is limited on most machines to 65535; option B<-sl>.
930 929
931=item B<internalBorder:> I<number> 930=item B<internalBorder:> I<number>
932 931
933Internal border of I<number> pixels. This resource is limited to 100; 932Internal border of I<number> pixels. This resource is limited to 100;
934option B<-b>. 933option B<-b>.
978=item B<cursorBlink:> I<boolean> 977=item B<cursorBlink:> I<boolean>
979 978
980B<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];
981option B<-bc>. 980option B<-bc>.
982 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
983=item B<pointerBlank:> I<boolean> 987=item B<pointerBlank:> I<boolean>
984 988
985B<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
986of seconds of inactivity. B<False>: the pointer is always visible 990of seconds of inactivity. B<False>: the pointer is always visible
987[default]. 991[default].
992 996
993=item B<pointerColor2:> I<colour> 997=item B<pointerColor2:> I<colour>
994 998
995Mouse pointer background colour. 999Mouse pointer background colour.
996 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
997=item B<pointerBlankDelay:> I<number> 1007=item B<pointerBlankDelay:> I<number>
998 1008
999Specifies number of seconds before blanking the pointer [default 2]. Use a 1009Specifies number of seconds before blanking the pointer [default 2]. Use a
1000large number (e.g. C<987654321>) to effectively disable the timeout. 1010large number (e.g. C<987654321>) to effectively disable the timeout.
1001 1011
1002=item B<backspacekey:> I<string> 1012=item B<backspacekey:> I<string>
1003 1013
1004The 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>
1005or 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>
1006(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
1007escape sequence. 1017escape sequence.
1008 1018
1009=item B<deletekey:> I<string> 1019=item B<deletekey:> I<string>
1010 1020
1027 1037
1028B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1038B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1029 1039
1030=item B<preeditType:> I<style> 1040=item B<preeditType:> I<style>
1031 1041
1032B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1042B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1033 1043
1034=item B<inputMethod:> I<name> 1044=item B<inputMethod:> I<name>
1035 1045
1036I<name> of inputMethod to use; option B<-im>. 1046I<name> of inputMethod to use; option B<-im>.
1037 1047
1055 1065
1056Change the meaning of triple-click selection with the left mouse 1066Change the meaning of triple-click selection with the left mouse
1057button. 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
1058the end of the logical line only; option B<-tcw>. 1068the end of the logical line only; option B<-tcw>.
1059 1069
1070=item B<disablePasteBrackets:> I<boolean>
1071
1072Prevent emission of paste bracket sequences; option B<-dpb>.
1073
1060=item B<insecure:> I<boolean> 1074=item B<insecure:> I<boolean>
1061 1075
1062Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1076Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1063echo 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
1064abused if somebody gets 8-bit-clean access to your display, whether 1078abused if somebody gets 8-bit-clean access to your display, whether
1065through a mail client displaying mail bodies unfiltered or through 1079through a mail client displaying mail bodies unfiltered or through
1066write(1) or any other means. Therefore, these sequences are disabled by 1080write(1) or any other means. Therefore, these sequences are disabled by
1067default. (Note that many other terminals, including xterm, have these 1081default. (Note that many other terminals, including xterm, have these
1085 1099
1086=item B<secondaryScreen:> I<boolean> 1100=item B<secondaryScreen:> I<boolean>
1087 1101
1088Turn on/off secondary screen (default enabled). 1102Turn on/off secondary screen (default enabled).
1089 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
1090=item B<secondaryScroll:> I<boolean> 1109=item B<secondaryScroll:> I<boolean>
1091 1110
1092Turn on/off secondary screen scroll (default enabled). If this 1111Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1112option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1113scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1114to/from the secondary screen will instead scroll the screen up.
1096 1115
1097=item B<hold>: I<boolean> 1116=item B<hold>: I<boolean>
1098 1117
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1118Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1119will not immediately destroy its window when the program executed within
1101it 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
1102user. 1121user.
1103 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
1104=item B<keysym.>I<sym>: I<string> 1130=item B<keysym.>I<sym>: I<action>
1105 1131
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1132Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1107intervening resource name B<keysym.> cannot be omitted. 1133resource name B<keysym.> cannot be omitted.
1108 1134
1109The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1135Using this resource, you can map key combinations such as
1110any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1136C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1111B<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
1112and 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
1113B<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
1114 1164
1115The 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
1116whatever 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
1117keys 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
1118current application keymap mode state. 1168current application keymap mode state.
1119 1169
1120The 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
1121searching 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
1122omitting 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
1123keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1182value (B<0x0000 - 0xFFFF>).
1124performed in an exact manner; however, the closest match is assured.
1125 1183
1126I<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
1127number), see RESOURCES in C<man 7 X> for futher details. 1186number), see RESOURCES in C<man 7 X> for further details.
1128 1187
1129You 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
1130with 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
1131should be a character not used by the strings. 1212the delimiter `/' should be a character not used by the strings.
1132 1213
1133Its usage can be demonstrated by an example: 1214Its usage can be demonstrated by an example:
1134 1215
1135 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1216 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1136 1217
1137The above line is equivalent to the following three lines: 1218The above line is equivalent to the following three lines:
1138 1219
1139 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1220 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1140 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1221 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1141 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1222 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1142 1223
1224=item command:STRING
1225
1143If 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>
1144is 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
1145example 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>
1146when Control-Meta-c is being pressed": 1233when Control-Meta-c is being pressed":
1147 1234
1148 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
1149 1236
1150If 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
1151is 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
1152manpage. For example, the F<selection> extension (activated via 1239font-switching at runtime:
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154 1240
1155 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
1156 1243
1157Due the the large number of modifier combinations, a defined key mapping 1244Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1158will match if at I<at least> the specified identifiers are being set, and 1245info):
1159no other key mappings with those and more bits are being defined. That
1160means that defining a key map for C<a> will automatically provide
1161definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1162mappings themselves.
1163 1246
1164Unfortunately, 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
1165if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1257For example if you overwrite the C<Insert> key you will disable
1166C<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
1167user-defined keymap using the C<builtin:> replacement: 1259"holes" into the user-defined keymap using the C<builtin:> replacement:
1168 1260
1169 URxvt.keysym.Insert: <my insert key sequence> 1261 URxvt.keysym.Insert: <my insert key sequence>
1170 URxvt.keysym.S-Insert: builtin: 1262 URxvt.keysym.S-Insert: builtin:
1171 1263
1172The 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
1173of modifiers. The second line re-establishes the default mapping for 1265of modifiers. The second line re-establishes the default mapping for
1174C<Shift-Insert>. 1266C<Shift-Insert>.
1175 1267
1176The following example will map Control-Meta-1 and Control-Meta-2 to 1268=item builtin-string:
1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1178font-switching at runtime:
1179 1269
1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1270This action is mainly useful to restore string mappings for keys that
1181 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.
1182 1275
1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1276An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1184info): 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:
1185 1280
1186 URxvt.keysym.M-C-3: command:\033[8;25;80t 1281 URxvt.keysym.S-Insert: builtin-string:
1187 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
1188 1318
1189=item B<perl-ext-common>: I<string> 1319=item B<perl-ext-common>: I<string>
1190 1320
1191=item B<perl-ext>: I<string> 1321=item B<perl-ext>: I<string>
1192 1322
1193Comma-separated list(s) of perl extension scripts (default: C<default>) to 1323Comma-separated list(s) of perl extension scripts (default: C<default>) to
1194use in this terminal instance; option B<-pe>. 1324use in this terminal instance; option B<-pe>.
1195 1325
1196Extension 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
1197them. This can be useful to selectively disable some extensions loaded 1327case they had been specified earlier. This can be useful to selectively
1198by default, or specified via the C<perl-ext-common> resource. For 1328disable some extensions loaded by default, or specified via the
1199example, C<default,-selection> will use all the default extension except 1329C<perl-ext-common> resource. For example, C<default,-selection> will use
1200C<selection>. 1330all the default extensions except C<selection>.
1201 1331
1202Extension names can also be followed by an argument in angle brackets 1332To prohibit autoloading of extensions, you can prefix them with C</>,
1203(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1333which will make urxvt refuse to automatically load them (this can be
1204searchable scrollback to Alt/Meta-s). Mentioning the same extension 1334overridden, however, by specifying the extension name again without a
1205multiple times with different arguments will pass multiple arguments to 1335prefix, though). This does not prohibit extensions themselves loading
1206the 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>.
1207 1347
1208Each extension is looked up in the library directories, loaded if 1348Each extension is looked up in the library directories, loaded if
1209necessary, 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.
1210 1352
1211If both of these resources are the empty string, then the perl 1353If both of these resources are the empty string, then the perl interpreter
1212interpreter will not be initialized. The idea behind two options is that 1354will not be initialized. The rationale for having two options is that
1213B<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
1214all instances, while B<perl-ext> is used for specific instances. 1356all instances, while B<perl-ext> is used for specific instances.
1215 1357
1216=item B<perl-eval>: I<string> 1358=item B<perl-eval>: I<string>
1217 1359
1218Perl code to be evaluated when all extensions have been registered. See 1360Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1361the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1362
1222=item B<perl-lib>: I<path> 1363=item B<perl-lib>: I<path>
1223 1364
1224Colon-separated list of additional directories that hold extension 1365Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1366scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1226@@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
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1368lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1369
1230See the @@RXVT_NAME@@perl(3) manpage. 1370See the @@RXVT_NAME@@perl(3) manpage.
1231 1371
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1372=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1373
1237=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1377=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1238 1378
1239Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1379Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1240for details. 1380for details.
1241 1381
1242=item B<searchable-scrollback:> I<keysym> 1382=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1243 1383
1244Sets the hotkey that starts the incremental scrollback buffer search 1384This resource is deprecated and will be removed. Use a B<keysym> resource
1245(default: C<M-s>). 1385instead, e.g.:
1246 1386
1387 URxvt.keysym.M-s: searchable-scrollback:start
1388
1247=item B<urlLauncher>: I<string> 1389=item B<url-launcher>: I<string>
1248 1390
1249Specifies 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
1250C<selection-popup> and C<matcher> perl extensions. 1392C<selection-popup> and C<matcher> perl extensions.
1251 1393
1252=item B<transient-for>: I<windowid> 1394=item B<transient-for>: I<windowid>
1255 1397
1256=item B<override-redirect>: I<boolean> 1398=item B<override-redirect>: I<boolean>
1257 1399
1258Compile I<frills>: Sets override-redirect for the terminal window, making 1400Compile I<frills>: Sets override-redirect for the terminal window, making
1259it 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).
1260 1406
1261=item B<iso14755_52:> I<boolean> 1407=item B<iso14755_52:> I<boolean>
1262 1408
1263Turn on/off ISO 14755 5.2 mode (default enabled). 1409Turn on/off ISO 14755 5.2 mode (default enabled).
1264 1410
1292=head1 THE SELECTION: SELECTING AND PASTING TEXT 1438=head1 THE SELECTION: SELECTING AND PASTING TEXT
1293 1439
1294The behaviour of text selection and insertion/pasting mechanism is similar 1440The behaviour of text selection and insertion/pasting mechanism is similar
1295to I<xterm>(1). 1441to I<xterm>(1).
1296 1442
1297=over 4 1443=over
1298 1444
1299=item B<Selecting>: 1445=item B<Selecting>:
1300 1446
1301Left 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
1302and release; Right click to extend the marked region; Left double-click 1448and release; Right click to extend the marked region; Left double-click
1317B<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.
1318 1464
1319Pressing 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
1320inserted too. 1466inserted too.
1321 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
1322=back 1474=back
1323 1475
1324=head1 CHANGING FONTS 1476=head1 CHANGING FONTS
1325 1477
1326Changing fonts (or font sizes, respectively) via the keypad is not yet 1478Changing fonts (or font sizes, respectively) via the keypad is not yet
1343and character codes using the keyboard. It consists of 4 parts. The 1495and character codes using the keyboard. It consists of 4 parts. The
1344first part is available if rxvt-unicode has been compiled with 1496first part is available if rxvt-unicode has been compiled with
1345C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1497C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1346with C<--enable-iso14755>. 1498with C<--enable-iso14755>.
1347 1499
1348=over 4 1500=over
1349 1501
1350=item * 5.1: Basic method 1502=item * 5.1: Basic method
1351 1503
1352This allows you to enter unicode characters using their hexcode. 1504This allows you to enter unicode characters using their hexcode.
1353 1505
1407B<@@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
1408it 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
1409allow 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
1410on 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.
1411 1563
1412=head1 COLORS AND GRAPHICS 1564=head1 COLOURS AND GRAPHICS
1413 1565
1414In addition to the default foreground and background colours, 1566In addition to the default foreground and background colours,
1415B<@@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
1416high-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
1417colours 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.
1418 1582
1419=begin table 1583=begin table
1420 1584
1421 B<color0> (black) = Black 1585 B<color0> (black) = Black
1422 B<color1> (red) = Red3 1586 B<color1> (red) = Red3
1442It is also possible to specify the colour values of B<foreground>, 1606It is also possible to specify the colour values of B<foreground>,
1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1607B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444a 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
1445color0-color15. 1609color0-color15.
1446 1610
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an 1611The following text gives values for the standard 88 colour mode (and
1448additional 72 colours. The first 64 of those (with indices 16 to 79) 1612values for the 256 colour mode in parentheses).
1449consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
145016>), followed by 8 additional shades of gray (with indices 80 to 87).
1451 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
1452Together, all those colours implement the 88 colour xterm colours. Only 1623Together, all those colours implement the 88 (256) colour xterm
1453the first 16 can be changed using resources currently, the rest can only 1624colours. Only the first 16 can be changed using resources currently, the
1454be 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...).
1455 1629
1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1630Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457always swapping the foreground/background colours. This is in contrast to 1631always swapping the foreground/background colours. This is in contrast to
1458I<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
1459been specified. For example, 1633been specified. For example,
1460 1634
1461=over 4
1462
1463=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1635 @@RXVT_NAME@@ -fg Black -bg White -rv
1464 1636
1465would 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
1466on White. 1638White.
1467
1468=back
1469 1639
1470=head2 ALPHA CHANNEL SUPPORT 1640=head2 ALPHA CHANNEL SUPPORT
1471 1641
1472If 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
1473their act together, rxvt-unicode will do it's own alpha channel management: 1643their act together, rxvt-unicode will do its own alpha channel management:
1474 1644
1475You can prefix any color with an opaquenes percentage enclosed in 1645You can prefix any colour with an opaqueness percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1646brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477(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
1478transparent 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
1479half-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
1480is the recommended format to specify transparency values, and works with 1650is the recommended format to specify transparency values, and works with
1481all ways to specify a colour. 1651all ways to specify a colour.
1482 1652
1515 1685
1516=head1 ENVIRONMENT 1686=head1 ENVIRONMENT
1517 1687
1518B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1688B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1519 1689
1520=over 4 1690=over
1521 1691
1522=item B<TERM> 1692=item B<TERM>
1523 1693
1524Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1694Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1525resources or on the command line. 1695resources or on the command line.
1560 1730
1561=item B<SHELL> 1731=item B<SHELL>
1562 1732
1563The 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>.
1564 1734
1565=item B<RXVT_SOCKET> 1735=item B<RXVT_SOCKET> [I<sic>]
1566 1736
1567The unix domain socket path used by @@RXVT_NAME@@c(1) and 1737The unix domain socket path used by @@RXVT_NAME@@c(1) and
1568@@RXVT_NAME@@d(1). 1738@@RXVT_NAME@@d(1).
1569 1739
1570Default 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).
1571 1751
1572=item B<HOME> 1752=item B<HOME>
1573 1753
1574Used to locate the default directory for the unix domain socket for 1754Used to locate the default directory for the unix domain socket for
1575daemon communications and to locate various resource files (such as 1755daemon communications and to locate various resource files (such as
1576C<.Xdefaults>) 1756C<.Xdefaults>)
1577 1757
1578=item B<XAPPLRESDIR> 1758=item B<XAPPLRESDIR>
1579 1759
1580Directory where various X resource files are being located. 1760Directory where application-specific X resource files are located.
1581 1761
1582=item B<XENVIRONMENT> 1762=item B<XENVIRONMENT>
1583 1763
1584If 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
1585@@RXVT_NAME@@. 1765@@RXVT_NAME@@.
1586 1766
1587=back 1767=back
1588 1768
1589=head1 FILES 1769=head1 FILES
1590 1770
1591=over 4 1771=over
1592 1772
1593=item B</usr/lib/X11/rgb.txt> 1773=item B</usr/lib/X11/rgb.txt>
1594 1774
1595Color names. 1775Colour names.
1596 1776
1597=back 1777=back
1598 1778
1599=head1 SEE ALSO 1779=head1 SEE ALSO
1600 1780
1781@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1601@@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)
1602 1783
1603=head1 CURRENT PROJECT COORDINATOR 1784=head1 CURRENT PROJECT COORDINATOR
1604 1785
1605=over 4 1786=over
1606 1787
1607=item Project Coordinator 1788=item Project Coordinator
1608 1789
1609Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1790Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1610 1791
1611L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1792L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1612 1793
1613=back 1794=back
1614 1795
1615=head1 AUTHORS 1796=head1 AUTHORS
1616 1797
1617=over 4 1798=over
1618 1799
1619=item John Bovey 1800=item John Bovey
1620 1801
1621University of Kent, 1992, wrote the original Xvt. 1802University of Kent, 1992, wrote the original Xvt.
1622 1803
1623=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1804=item Rob Nation <nation@rocket.sanders.lockheed.com>
1624 1805
1625very heavily modified Xvt and came up with Rxvt 1806very heavily modified Xvt and came up with Rxvt
1626 1807
1627=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1808=item Angelo Haritsis <ah@doc.ic.ac.uk>
1628 1809
1629wrote the Greek Keyboard Input (no longer in code) 1810wrote the Greek Keyboard Input (no longer in code)
1630 1811
1631=item mj olesen L<< <olesen@me.QueensU.CA> >> 1812=item mj olesen <olesen@me.QueensU.CA>
1632 1813
1633Wrote the menu system. 1814Wrote the menu system.
1634 1815
1635Project Coordinator (changes.txt 2.11 to 2.21) 1816Project Coordinator (changes.txt 2.11 to 2.21)
1636 1817
1637=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1818=item Oezguer Kesim <kesim@math.fu-berlin.de>
1638 1819
1639Project Coordinator (changes.txt 2.21a to 2.4.5) 1820Project Coordinator (changes.txt 2.21a to 2.4.5)
1640 1821
1641=item Geoff Wing L<< <gcw@pobox.com> >> 1822=item Geoff Wing <gcw@pobox.com>
1642 1823
1643Rewrote screen display and text selection routines. 1824Rewrote screen display and text selection routines.
1644 1825
1645Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1826Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1646 1827
1647=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1828=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1648 1829
1649Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1830Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1650extension, random hacks, numerous bugfixes and extensions. 1831extension, random hacks, numerous bugfixes and extensions.
1651 1832
1652Project Coordinator (Changes 1.0 -) 1833Project Coordinator (Changes 1.0 -)
1653 1834
1654=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1835=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1655 1836
1656Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1837pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1657 1838
1658=back 1839=back
1659 1840

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines