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.166 by root, Fri Oct 10 13:23:56 2008 UTC vs.
Revision 1.258 by root, Mon Nov 22 17:01:36 2021 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>
… …
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
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
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
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 132
137=item B<-fade> I<number> 133=item B<-fade> I<number>
138 134
139Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
… …
143=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
144 140
145Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
147 143
148=item B<-tint> I<colour> 144=item B<-icon> I<file>
149 145
150Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
151transparency is enabled with B<-tr>. This only works for 147is used by many window managers, taskbars and pagers to represent the
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application 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 149
187=item B<-bg> I<colour> 150=item B<-bg> I<colour>
188 151
189Window background colour; resource B<background>. 152Window background colour; resource B<background>.
190 153
191=item B<-fg> I<colour> 154=item B<-fg> I<colour>
192 155
193Window foreground colour; resource B<foreground>. 156Window 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 157
202=item B<-cr> I<colour> 158=item B<-cr> I<colour>
203 159
204The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
205 161
… …
264 220
265=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
266 222
267Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
268 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
269=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
270 230
271Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
272B<utmpInhibit>. 232B<utmpInhibit>.
273 233
… …
315 275
316=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
317 277
318Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
319 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
320=item B<-iconic> 284=item B<-iconic>
321 285
322Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 287Alternative form is B<-ic>.
324 288
… …
348=item B<-override-redirect> 312=item B<-override-redirect>
349 313
350Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
351B<override-redirect>. 315B<override-redirect>.
352 316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
321
353=item B<-sbg> 322=item B<-sbg>
354 323
355Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
356drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
357this if you have a good font and want to use its block graphic glyphs; 326this if you have a good font and want to use its block graphic glyphs;
… …
360=item B<-lsp> I<number> 329=item B<-lsp> I<number>
361 330
362Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
363the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
364B<lineSpace>. 333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
365 341
366=item B<-tn> I<termname> 342=item B<-tn> I<termname>
367 343
368This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
369B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
… …
404=item B<-pt> I<style> 380=item B<-pt> I<style>
405 381
406Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
407B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
408 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
409=item B<-im> I<text> 388=item B<-im> I<text>
410 389
411Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
412 391
413=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
… …
427Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
428button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
429in-use. Instead of selecting a full line it will extend the selection to 408in-use. Instead of selecting a full line it will extend the selection to
430the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
431 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420
432=item B<-insecure> 421=item B<-insecure>
433 422
434Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
435sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
436info. 425info.
… …
448 437
449=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
450 439
451Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
452B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
453 450
454=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
455 452
456Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
457will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
… …
536 533
537 # now communicate with rxvt 534 # now communicate with rxvt
538 my $slave = $pty->slave; 535 my $slave = $pty->slave;
539 while (<$slave>) { print $slave "got <$_>\n" } 536 while (<$slave>) { print $slave "got <$_>\n" }
540 537
538Note that, despite what the name might imply, the file descriptor does not
539need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
540domain or tcp socket). While tty operations cannot be done in this case,
541B<@@RXVT_NAME@@> can still be remote controlled with it:
542
543 use Socket;
544 use Fcntl;
545
546 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
547 fcntl $slave, Fcntl::F_SETFD, 0;
548 system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
549 close $slave;
550
551 syswrite $URXVT, "Type a secret password: ";
552 my $secret = do { local $/ = "\r"; <$URXVT> };
553 print "Not so secret anymore: $secret\n";
554
541=item B<-pe> I<string> 555=item B<-pe> I<string>
542 556
543Comma-separated list of perl extension scripts to use (or not to use) in 557Comma-separated list of perl extension scripts to use (or not to use) in
544this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
545 559
… …
554You can set and change the resources using X11 tools like B<xrdb>. Many 568You can set and change the resources using X11 tools like B<xrdb>. Many
555distribution do also load settings from the B<~/.Xresources> file when X 569distribution do also load settings from the B<~/.Xresources> file when X
556starts. @@RXVT_NAME@@ will consult the following files/resources in order, 570starts. @@RXVT_NAME@@ will consult the following files/resources in order,
557with later settings overwriting earlier ones: 571with later settings overwriting earlier ones:
558 572
559 1. system-wide app-defaults file, either locale-dependent OR global
560 2. app-defaults file in $XAPPLRESDIR 573 1. app-defaults file in $XAPPLRESDIR
574 2. $HOME/.Xdefaults
561 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 575 3. RESOURCE_MANAGER property on root-window of screen 0
562 4. SCREEN_RESOURCES for the current screen 576 4. SCREEN_RESOURCES property on root-window of the current screen
563 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 577 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
564 6. resources specified via -xrm on the commandline 578 6. resources specified via -xrm on the commandline
565 579
566Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 580Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
567names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 581names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
572be used. Command-line arguments can be used to override resource 586be used. Command-line arguments can be used to override resource
573settings. The following resources are supported (you might want to 587settings. The following resources are supported (you might want to
574check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 588check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
575extensions not documented here): 589extensions not documented here):
576 590
577=over 4 591=over
578 592
579=item B<depth:> I<bitdepth> 593=item B<depth:> I<bitdepth>
580 594
581Compile I<xft>: Attempt to find a visual with the given bit depth; 595Compile I<xft>: Attempt to find a visual with the given bit depth;
582option B<-depth>. 596option B<-depth>.
… …
608Use the specified colour for the colour value I<n>, where 0-7 622Use the specified colour for the colour value I<n>, where 0-7
609corresponds to low-intensity (normal) colours and 8-15 corresponds to 623corresponds to low-intensity (normal) colours and 8-15 corresponds to
610high-intensity (bold = bright foreground, blink = bright background) 624high-intensity (bold = bright foreground, blink = bright background)
611colours. The canonical names are as follows: 0=black, 1=red, 2=green, 625colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6123=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6263=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
613names used are listed in the B<COLORS AND GRAPHICS> section. 627names used are listed in the B<COLOURS AND GRAPHICS> section.
614 628
615Colours higher than 15 cannot be set using resources (yet), but can be 629Colours higher than 15 cannot be set using resources (yet), but can be
616changed using an escape command (see @@RXVT_NAME@@(7)). 630changed using an escape command (see @@RXVT_NAME@@(7)).
617 631
618Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 632Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
629=item B<colorUL:> I<colour> 643=item B<colorUL:> I<colour>
630 644
631Use the specified colour to display underlined characters when the 645Use the specified colour to display underlined characters when the
632foreground colour is the default. 646foreground colour is the default.
633 647
634=item B<colorRV:> I<colour>
635
636Use the specified colour as the background for reverse video characters
637when OPTION_HC is disabled (--disable-frills).
638
639=item B<underlineColor:> I<colour> 648=item B<underlineColor:> I<colour>
640 649
641If set, use the specified colour as the colour for the underline 650If set, use the specified colour as the colour for the underline
642itself. If unset, use the foreground colour. 651itself. If unset, use the foreground colour.
652
653=item B<highlightColor:> I<colour>
654
655If set, use the specified colour as the background for highlighted
656characters. If unset, use reverse video.
657
658=item B<highlightTextColor:> I<colour>
659
660If set and highlightColor is set, use the specified colour as the
661foreground for highlighted characters.
643 662
644=item B<cursorColor:> I<colour> 663=item B<cursorColor:> I<colour>
645 664
646Use the specified colour for the cursor. The default is to use the 665Use the specified colour for the cursor. The default is to use the
647foreground colour; option B<-cr>. 666foreground colour; option B<-cr>.
… …
654 673
655=item B<reverseVideo:> I<boolean> 674=item B<reverseVideo:> I<boolean>
656 675
657B<True>: simulate reverse video by foreground and background colours; 676B<True>: simulate reverse video by foreground and background colours;
658option B<-rv>. B<False>: regular screen colours [default]; option 677option B<-rv>. B<False>: regular screen colours [default]; option
659B<+rv>. See note in B<COLORS AND GRAPHICS> section. 678B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
660 679
661=item B<jumpScroll:> I<boolean> 680=item B<jumpScroll:> I<boolean>
662 681
663B<True>: specify that jump scrolling should be used. When receiving lots 682B<True>: specify that jump scrolling should be used. When receiving lots
664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 683of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
678 697
679B<False>: specify that everything is to be displayed, even 698B<False>: specify that everything is to be displayed, even
680if the refresh is too fast for the human eye to read anything (or the 699if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>. 700monitor to display anything); option B<+ss>.
682 701
683=item B<transparent:> I<boolean>
684
685Turn on/off illusion of a transparent window background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
689
690I<Please address all transparency related issues to Sasha Vasko at
691sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
692
693=item B<fading:> I<number> 702=item B<fading:> I<number>
694 703
695Fade the text by the given percentage when focus is lost; option B<-fade>. 704Fade the text by the given percentage when focus is lost; option B<-fade>.
696 705
697=item B<fadeColor:> I<colour> 706=item B<fadeColor:> I<colour>
698 707
699Fade to this colour, when fading is used (see B<fading:>). The default 708Fade to this colour, when fading is used (see B<fading:>). The default
700colour is black; option B<-fadecolor>. 709colour is black; option B<-fadecolor>.
701 710
702=item B<tintColor:> I<colour> 711=item B<iconFile:> I<file>
703 712
704Tint the transparent background pixmap with the given colour; option 713Set the application icon pixmap; option B<-icon>.
705B<-tint>.
706
707=item B<shading:> I<number>
708
709Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
710in addition to tinting it; option B<-sh>.
711
712=item B<blendType:> I<string>
713
714Specify background blending type; option B<-blt>.
715
716=item B<blurRadius:> I<number>
717
718Apply Gaussian Blurr with the specified radius to the transparent
719background image; option B<-blr>.
720 714
721=item B<scrollColor:> I<colour> 715=item B<scrollColor:> I<colour>
722 716
723Use the specified colour for the scrollbar [default #B2B2B2]. 717Use the specified colour for the scrollbar [default #B2B2B2].
724 718
… …
729 723
730=item B<borderColor:> I<colour> 724=item B<borderColor:> I<colour>
731 725
732The colour of the border around the text area and between the scrollbar 726The colour of the border around the text area and between the scrollbar
733and the text. 727and the text.
734
735=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
736
737Use the specified image file for the background and also
738optionally specify its scaling with a geometry string B<WxH+X+Y>,
739(default C<0x0+50+50>) in which B<"W" / "H"> specify the
740horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
741centre (percent). A scale of 0 displays the image with tiling. A scale
742of 1 displays the image without any scaling. A scale of 2 to 9 specifies
743an integer number of images in that direction. No image will be magnified
744beyond 10 times its original size. The maximum permitted scale is 1000.
745Additional operations can be specified after colon B<:op1:op2...>.
746Supported operations are:
747
748 tile force background image to be tiled and not scaled. Equivalent to 0x0
749 propscale will scale image keeping proportions
750 auto will scale image to match window size. Equivalent to 100x100
751 hscale will scale image horizontally to the window size
752 vscale will scale image vertically to the window size
753 scale will scale image to match window size
754 root will tile image as if it was a root window background, auto-adjusting
755 whenever terminal window moves
756
757If used in conjunction with B<-tr> option, the specified pixmap will be
758blended over transparency image using either alpha-blending, or any
759other blending type, specified with B<-blt "type"> option.
760
761=item B<path:> I<path>
762
763Specify the colon-delimited search path for finding background image files.
764 728
765=item B<font:> I<fontlist> 729=item B<font:> I<fontlist>
766 730
767Select the fonts to be used. This is a comma separated list of font names 731Select the fonts to be used. This is a comma separated list of font names
768that are checked in order when trying to find glyphs for characters. The 732that are checked in order when trying to find glyphs for characters. The
… …
791it is named first) and thus defines the character cell grid to be 9 pixels 755it is named first) and thus defines the character cell grid to be 9 pixels
792wide and 15 pixels high. 756wide and 15 pixels high.
793 757
794The second font is just used to add additional unicode characters not in 758The second font is just used to add additional unicode characters not in
795the base font, likewise the third, which is unfortunately non-bold, but 759the base font, likewise the third, which is unfortunately non-bold, but
796the bold version of the font does contain less characters, so this is a 760the bold version of the font does contain fewer characters, so this is a
797useful supplement. 761useful supplement.
798 762
799The third font is an Xft font with aliasing turned off, and the characters 763The third font is an Xft font with aliasing turned off, and the characters
800are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 764are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
801contains other characters, but we are not interested in them. 765contains other characters, but we are not interested in them.
… …
852=item B<urgentOnBell:> I<boolean> 816=item B<urgentOnBell:> I<boolean>
853 817
854B<True>: set the urgency hint for the wm on receipt of a bell character. 818B<True>: set the urgency hint for the wm on receipt of a bell character.
855B<False>: do not set the urgency hint [default]. 819B<False>: do not set the urgency hint [default].
856 820
821@@RXVT_NAME@@ resets the urgency hint on every focus change.
822
857=item B<visualBell:> I<boolean> 823=item B<visualBell:> I<boolean>
858 824
859B<True>: use visual bell on receipt of a bell character; option B<-vb>. 825B<True>: use visual bell on receipt of a bell character; option B<-vb>.
860B<False>: no visual bell [default]; option B<+vb>. 826B<False>: no visual bell [default]; option B<+vb>.
861 827
… …
863 829
864B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 830B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
865the shell; option B<-ls>. B<False>: start as a normal sub-shell 831the shell; option B<-ls>. B<False>: start as a normal sub-shell
866[default]; option B<+ls>. 832[default]; option B<+ls>.
867 833
834=item B<multiClickTime:> I<number>
835
836Specify the maximum time in milliseconds between multi-click select
837events. The default is 500 milliseconds; option B<-mc>.
838
868=item B<utmpInhibit:> I<boolean> 839=item B<utmpInhibit:> I<boolean>
869 840
870B<True>: inhibit writing record into the system log file B<utmp>; 841B<True>: inhibit writing record into the system log file B<utmp>;
871option B<-ut>. B<False>: write record into the system log file B<utmp> 842option B<-ut>. B<False>: write record into the system log file B<utmp>
872[default]; option B<+ut>. 843[default]; option B<+ut>.
… …
889=item B<scrollstyle:> I<mode> 860=item B<scrollstyle:> I<mode>
890 861
891Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 862Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
892the author's favourite. 863the author's favourite.
893 864
865=item B<thickness:> I<number>
866
867Set the scrollbar width in pixels.
868
894=item B<scrollBar:> I<boolean> 869=item B<scrollBar:> I<boolean>
895 870
896B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 871B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
897disable the scrollbar; option B<+sb>. 872disable the scrollbar; option B<+sb>.
898 873
… …
917B<False>: do not scroll to bottom when tty receives output; option 892B<False>: do not scroll to bottom when tty receives output; option
918B<+si>. 893B<+si>.
919 894
920=item B<scrollWithBuffer:> I<boolean> 895=item B<scrollWithBuffer:> I<boolean>
921 896
922B<True>: scroll with scrollback buffer when tty receives new lines (and 897B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
923B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 898try to show the same lines) and B<scrollTtyOutput> is False; option
924with scrollback buffer when tty receives new lines; option B<+sw>. 899B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
900new lines; option B<+sw>.
925 901
926=item B<scrollTtyKeypress:> I<boolean> 902=item B<scrollTtyKeypress:> I<boolean>
927 903
928B<True>: scroll to bottom when a non-special key is pressed. Special keys 904B<True>: scroll to bottom when a non-special key is pressed. Special keys
929are those which are intercepted by rxvt-unicode for special handling and 905are those which are intercepted by rxvt-unicode for special handling and
930are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 906are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
931bottom when a non-special key is pressed; option B<+sk>. 907bottom when a non-special key is pressed; option B<+sk>.
932 908
933=item B<saveLines:> I<number> 909=item B<saveLines:> I<number>
934 910
935Save I<number> lines in the scrollback buffer [default 64]. This 911Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
936resource is limited on most machines to 65535; option B<-sl>.
937 912
938=item B<internalBorder:> I<number> 913=item B<internalBorder:> I<number>
939 914
940Internal border of I<number> pixels. This resource is limited to 100; 915Internal border of I<number> pixels. This resource is limited to 100;
941option B<-b>. 916option B<-b>.
… …
985=item B<cursorBlink:> I<boolean> 960=item B<cursorBlink:> I<boolean>
986 961
987B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 962B<True>: blink the cursor. B<False>: do not blink the cursor [default];
988option B<-bc>. 963option B<-bc>.
989 964
965=item B<cursorUnderline:> I<boolean>
966
967B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
968option B<-uc>.
969
990=item B<pointerBlank:> I<boolean> 970=item B<pointerBlank:> I<boolean>
991 971
992B<True>: blank the pointer when a key is pressed or after a set number 972B<True>: blank the pointer when a key is pressed or after a set number
993of seconds of inactivity. B<False>: the pointer is always visible 973of seconds of inactivity. B<False>: the pointer is always visible
994[default]. 974[default].
… …
999 979
1000=item B<pointerColor2:> I<colour> 980=item B<pointerColor2:> I<colour>
1001 981
1002Mouse pointer background colour. 982Mouse pointer background colour.
1003 983
984=item B<pointerShape:> I<string>
985
986Compile I<frills>: Specifies the name of the mouse pointer shape
987[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
988file for possible values (omit the C<XC_> prefix).
989
1004=item B<pointerBlankDelay:> I<number> 990=item B<pointerBlankDelay:> I<number>
1005 991
1006Specifies number of seconds before blanking the pointer [default 2]. Use a 992Specifies number of seconds before blanking the pointer [default 2]. Use a
1007large number (e.g. C<987654321>) to effectively disable the timeout. 993large number (e.g. C<987654321>) to effectively disable the timeout.
1008 994
1009=item B<backspacekey:> I<string> 995=item B<backspacekey:> I<string>
1010 996
1011The string to send when the backspace key is pressed. If set to B<DEC> 997The string to send when the backspace key is pressed. If set to B<DEC>
1012or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 998or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1013(code 8) - which can be reversed with the appropriate DEC private mode 999(code 8) - which can be reversed with the appropriate DEC private mode
1014escape sequence. 1000escape sequence.
1015 1001
1016=item B<deletekey:> I<string> 1002=item B<deletekey:> I<string>
1017 1003
… …
1034 1020
1035B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1036 1022
1037=item B<preeditType:> I<style> 1023=item B<preeditType:> I<style>
1038 1024
1039B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1025B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1040 1026
1041=item B<inputMethod:> I<name> 1027=item B<inputMethod:> I<name>
1042 1028
1043I<name> of inputMethod to use; option B<-im>. 1029I<name> of inputMethod to use; option B<-im>.
1044 1030
… …
1062 1048
1063Change the meaning of triple-click selection with the left mouse 1049Change the meaning of triple-click selection with the left mouse
1064button. Instead of selecting a full line it will extend the selection to 1050button. Instead of selecting a full line it will extend the selection to
1065the end of the logical line only; option B<-tcw>. 1051the end of the logical line only; option B<-tcw>.
1066 1052
1053=item B<disablePasteBrackets:> I<boolean>
1054
1055Prevent emission of paste bracket sequences; option B<-dpb>.
1056
1067=item B<insecure:> I<boolean> 1057=item B<insecure:> I<boolean>
1068 1058
1069Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1059Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1070echo arbitrary strings like the icon name or the locale. This could be 1060echo arbitrary strings like the icon name or the locale. This could be
1071abused if somebody gets 8-bit-clean access to your display, whether 1061abused if somebody gets 8-bit-clean access to your display, whether
1072through a mail client displaying mail bodies unfiltered or through 1062through a mail client displaying mail bodies unfiltered or through
1073write(1) or any other means. Therefore, these sequences are disabled by 1063write(1) or any other means. Therefore, these sequences are disabled by
1074default. (Note that many other terminals, including xterm, have these 1064default. (Note that many other terminals, including xterm, have these
… …
1092 1082
1093=item B<secondaryScreen:> I<boolean> 1083=item B<secondaryScreen:> I<boolean>
1094 1084
1095Turn on/off secondary screen (default enabled). 1085Turn on/off secondary screen (default enabled).
1096 1086
1087=item B<rewrapMode:> I<mode>
1088
1089Sets long line rewrap behaviour on window resize to one of B<auto>
1090(default), B<always> or B<never>.
1091
1097=item B<secondaryScroll:> I<boolean> 1092=item B<secondaryScroll:> I<boolean>
1098 1093
1099Turn on/off secondary screen scroll (default enabled). If this 1094Turn on/off secondary screen scroll (default enabled). If this
1100option is enabled, scrolls on the secondary screen will change the 1095option is enabled, scrolls on the secondary screen will change the
1101scrollback buffer and, when secondaryScreen is off, switching 1096scrollback buffer and, when secondaryScreen is off, switching
… …
1113Sets the working directory for the shell (or the command specified via 1108Sets the working directory for the shell (or the command specified via
1114B<-e>). The I<path> must be an absolute path and it must exist for 1109B<-e>). The I<path> must be an absolute path and it must exist for
1115@@RXVT_NAME@@ to start. If it isn't specified then the current working 1110@@RXVT_NAME@@ to start. If it isn't specified then the current working
1116directory will be used; option B<-cd>. 1111directory will be used; option B<-cd>.
1117 1112
1118=item B<keysym.>I<sym>: I<string> 1113=item B<keysym.>I<sym>: I<action>
1119 1114
1120Compile I<frills>: Associate I<string> with keysym I<sym>. The 1115Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1121intervening resource name B<keysym.> cannot be omitted. 1116resource name B<keysym.> cannot be omitted.
1122 1117
1123The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1118Using this resource, you can map key combinations such as
1124any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1119C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1125B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1120string than would normally result from that combination, making the
1126and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1121terminal scroll up or down the way you want it, or any other thing an
1127B<2>, B<3>, B<4>, B<5>. 1122extension might provide.
1123
1124The key combination that triggers the action, I<sym>, has the following format:
1125
1126 (modifiers-)key
1127
1128Where I<modifiers> can be any combination of the following full or
1129abbreviated modifier names:
1130
1131=begin table
1132
1133 B<ISOLevel3> B<I>
1134 B<AppKeypad> B<K>
1135 B<Control> B<C>
1136 B<NumLock> B<N>
1137 B<Shift> B<S>
1138 B<Meta> B<M> I<or> B<A>
1139 B<Lock> B<L>
1140 B<Mod1> B<1>
1141 B<Mod2> B<2>
1142 B<Mod3> B<3>
1143 B<Mod4> B<4>
1144 B<Mod5> B<5>
1145
1146=end table
1128 1147
1129The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1148The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1130whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1149whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1131keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1150keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1132current application keymap mode state. 1151current application keymap mode state.
1133 1152
1134The spellings of I<key> can be obtained by using B<xev>(1) command or 1153Due the the large number of modifier combinations, a key mapping will
1135searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1154match if I<at least> the specified identifiers are being set, and no other
1155key mappings with those and more bits are being defined. That means that
1156defining a mapping for C<a> will automatically provide definitions for
1157C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1158themselves. See the C<builtin:> action, below, for a way to work around
1159this when this is a problem.
1160
1161The spelling of I<key> depends on your implementation of X. An easy way to
1162find a key name is to use the B<xev>(1) command. You can find a list by
1163looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1136omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1164the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1137keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1165value (B<0x0000 - 0xFFFF>).
1138performed in an exact manner; however, the closest match is assured.
1139 1166
1140I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1167As with any resource value, the I<action> string may contain backslash
1168escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1141number), see RESOURCES in C<man 7 X> for futher details. 1169number), see RESOURCES in C<man 7 X> for further details.
1142 1170
1143You can define a range of keysyms in one shot by providing a I<string> 1171An action starts with an action prefix that selects a certain type
1144with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1172of action, followed by a colon. An action string without colons is
1173interpreted as a literal string to pass to the tty (as if it was
1174prefixed with C<string:>).
1175
1176The following action prefixes are known - extensions can provide
1177additional prefixes:
1178
1179=over
1180
1181=item string:STRING
1182
1183If the I<action> starts with C<string:> (or otherwise contains no colons),
1184then the remaining C<STRING> will be passed to the program running in the
1185terminal. For example, you could replace whatever Shift-Tab outputs by the
1186string C<echo rm -rf /> followed by a newline:
1187
1188 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1189
1190This could in theory be used to completely redefine your keymap.
1191
1192In addition, for actions of this type, you can define a range of
1193keysyms in one shot by loading the C<keysym-list> perl extension and
1194providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1145should be a character not used by the strings. 1195the delimiter `/' should be a character not used by the strings.
1146 1196
1147Its usage can be demonstrated by an example: 1197Its usage can be demonstrated by an example:
1148 1198
1149 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1199 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1150 1200
1151The above line is equivalent to the following three lines: 1201The above line is equivalent to the following three lines:
1152 1202
1153 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1203 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1154 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1204 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1155 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1205 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1156 1206
1207=item command:STRING
1208
1157If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1209If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1158is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1210is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1211the opposite of C<string:> - instead of sending it to the program running
1212in the terminal, it will be treated as if it were program output). This is
1213most useful to feed command sequences into @@RXVT_NAME@@.
1214
1159example the following means "change the current locale to C<zh_CN.GBK> 1215For example the following means "change the current locale to C<zh_CN.GBK>
1160when Control-Meta-c is being pressed": 1216when Control-Meta-c is being pressed":
1161 1217
1162 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1218 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1163 1219
1164If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1220The following example will map Control-Meta-1 and Control-Meta-2 to
1165is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1221the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1166manpage. For example, the F<selection> extension (activated via 1222font-switching at runtime:
1167C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1168 1223
1169 URxvt.keysym.M-C-c: perl:selection:rot13 1224 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1225 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1170 1226
1171Due the the large number of modifier combinations, a defined key mapping 1227Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1172will match if at I<at least> the specified identifiers are being set, and 1228info):
1173no other key mappings with those and more bits are being defined. That
1174means that defining a key map for C<a> will automatically provide
1175definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1176mappings themselves.
1177 1229
1178Unfortunately, this will override built-in key mappings. For example 1230 URxvt.keysym.M-C-3: command:\033[8;25;80t
1231 URxvt.keysym.M-C-4: command:\033[8;48;110t
1232
1233=item builtin:
1234
1235The builtin action is the action that @@RXVT_NAME@@ would execute if no
1236key binding existed for the key combination. The obvious use is to undo
1237the effect of existing bindings. The not so obvious use is to reinstate
1238bindings when another binding overrides too many modifiers.
1239
1179if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1240For example if you overwrite the C<Insert> key you will disable
1180C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1241@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1181user-defined keymap using the C<builtin:> replacement: 1242"holes" into the user-defined keymap using the C<builtin:> replacement:
1182 1243
1183 URxvt.keysym.Insert: <my insert key sequence> 1244 URxvt.keysym.Insert: <my insert key sequence>
1184 URxvt.keysym.S-Insert: builtin: 1245 URxvt.keysym.S-Insert: builtin:
1185 1246
1186The first line defines a mapping for C<Insert> and I<any> combination 1247The first line defines a mapping for C<Insert> and I<any> combination
1187of modifiers. The second line re-establishes the default mapping for 1248of modifiers. The second line re-establishes the default mapping for
1188C<Shift-Insert>. 1249C<Shift-Insert>.
1189 1250
1190The following example will map Control-Meta-1 and Control-Meta-2 to 1251=item builtin-string:
1191the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1192font-switching at runtime:
1193 1252
1194 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1253This action is mainly useful to restore string mappings for keys that
1195 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1254have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1255difficult to explain - basically, this action will send the string to the
1256application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1257action for it.
1196 1258
1197Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1259An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1198info): 1260selection when you press C<Shift-Insert>. With the following bindings, it
1261would instead emit the (undocumented, but what applications running in the
1262terminal might expect) sequence C<ESC [ 2 $> instead:
1199 1263
1200 URxvt.keysym.M-C-3: command:\033[8;25;80t 1264 URxvt.keysym.S-Insert: builtin-string:
1201 URxvt.keysym.M-C-4: command:\033[8;48;110t 1265 URxvt.keysym.C-S-Insert: builtin:
1266
1267The first line disables the paste functionality for that key
1268combination, and the second reinstates the default behaviour for
1269C<Control-Shift-Insert>, which would otherwise be overridden.
1270
1271Similarly, to let applications gain access to the C<C-M-c> (copy to
1272clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1273this:
1274
1275 URxvt.keysym.C-M-c: builtin-string:
1276 URxvt.keysym.C-M-v: builtin-string:
1277
1278=item EXTENSION:STRING
1279
1280An action of this form invokes the action B<STRING>, if any, provided
1281by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1282be loaded automatically if necessary.
1283
1284Not all extensions define actions, but popular extensions that do
1285include the I<selection> and I<matcher> extensions (documented in their
1286own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1287respectively).
1288
1289From the silly examples department, this will rot13-"encrypt"
1290@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1291keyboards:
1292
1293 URxvt.keysym.M-C-c: selection:rot13
1294
1295=item perl:STRING *DEPRECATED*
1296
1297This is a deprecated way of invoking commands provided by perl
1298extensions. It is still supported, but should not be used anymore.
1299
1300=back
1202 1301
1203=item B<perl-ext-common>: I<string> 1302=item B<perl-ext-common>: I<string>
1204 1303
1205=item B<perl-ext>: I<string> 1304=item B<perl-ext>: I<string>
1206 1305
1207Comma-separated list(s) of perl extension scripts (default: C<default>) to 1306Comma-separated list(s) of perl extension scripts (default: C<default>) to
1208use in this terminal instance; option B<-pe>. 1307use in this terminal instance; option B<-pe>.
1209 1308
1210Extension names can be prefixed with a C<-> sign to prohibit using 1309Extension names can be prefixed with a C<-> sign to remove them again, in
1211them. This can be useful to selectively disable some extensions loaded 1310case they had been specified earlier. This can be useful to selectively
1212by default, or specified via the C<perl-ext-common> resource. For 1311disable some extensions loaded by default, or specified via the
1213example, C<default,-selection> will use all the default extension except 1312C<perl-ext-common> resource. For example, C<default,-selection> will use
1214C<selection>. 1313all the default extensions except C<selection>.
1215 1314
1216Extension names can also be followed by an argument in angle brackets 1315To prohibit autoloading of extensions, you can prefix them with C</>,
1217(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1316which will make urxvt refuse to automatically load them (this can be
1218searchable scrollback to Alt/Meta-s). Mentioning the same extension 1317overriden, however, by specifying the extension name again without a
1219multiple times with different arguments will pass multiple arguments to 1318prefix, though). This does not prohibit extensions themselves loading
1220the extension. 1319other extensions. For example, C<default,/background> will keep the
1320C<background> extension from being loaded when a background OSC sequence
1321is received.
1322
1323The default set includes the C<selection>, C<option-popup>,
1324C<selection-popup>, C<readline>, C<searchable-scrollback> and
1325C<confirm-paste> extensions, as well as any extensions which are mentioned
1326in B<keysym> resources.
1327
1328Any extension such that a corresponding resource is given on the
1329command line is automatically appended to B<perl-ext>.
1221 1330
1222Each extension is looked up in the library directories, loaded if 1331Each extension is looked up in the library directories, loaded if
1223necessary, and bound to the current terminal instance. 1332necessary, and bound to the current terminal instance. When the library
1333search path contains multiple extension files of the same name, then the
1334first one found will be used.
1224 1335
1225If both of these resources are the empty string, then the perl 1336If both of these resources are the empty string, then the perl interpreter
1226interpreter will not be initialized. The idea behind two options is that 1337will not be initialized. The rationale for having two options is that
1227B<perl-ext-common> will be used for extensions that should be available to 1338B<perl-ext-common> will be used for extensions that should be available to
1228all instances, while B<perl-ext> is used for specific instances. 1339all instances, while B<perl-ext> is used for specific instances.
1229 1340
1230=item B<perl-eval>: I<string> 1341=item B<perl-eval>: I<string>
1231 1342
… …
1233the @@RXVT_NAME@@perl(3) manpage. 1344the @@RXVT_NAME@@perl(3) manpage.
1234 1345
1235=item B<perl-lib>: I<path> 1346=item B<perl-lib>: I<path>
1236 1347
1237Colon-separated list of additional directories that hold extension 1348Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource, 1349scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1239@@RXVT_NAME@@ will first look in these directories and then in 1350in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1351lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241 1352
1242See the @@RXVT_NAME@@perl(3) manpage. 1353See the @@RXVT_NAME@@perl(3) manpage.
1243 1354
1244=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1355=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1245 1356
… …
1249=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1360=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1250 1361
1251Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1362Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1252for details. 1363for details.
1253 1364
1254=item B<searchable-scrollback:> I<keysym> 1365=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1255 1366
1256Sets the hotkey that starts the incremental scrollback buffer search 1367This resource is deprecated and will be removed. Use a B<keysym> resource
1257(default: C<M-s>). 1368instead, e.g.:
1258 1369
1370 URxvt.keysym.M-s: searchable-scrollback:start
1371
1259=item B<urlLauncher>: I<string> 1372=item B<url-launcher>: I<string>
1260 1373
1261Specifies the program to be started with a URL argument. Used by the 1374Specifies the program to be started with a URL argument. Used by the
1262C<selection-popup> and C<matcher> perl extensions. 1375C<selection-popup> and C<matcher> perl extensions.
1263 1376
1264=item B<transient-for>: I<windowid> 1377=item B<transient-for>: I<windowid>
… …
1267 1380
1268=item B<override-redirect>: I<boolean> 1381=item B<override-redirect>: I<boolean>
1269 1382
1270Compile I<frills>: Sets override-redirect for the terminal window, making 1383Compile I<frills>: Sets override-redirect for the terminal window, making
1271it almost invisible to window managers; option B<-override-redirect>. 1384it almost invisible to window managers; option B<-override-redirect>.
1385
1386=item B<iso14755:> I<boolean>
1387
1388Turn on/off ISO 14755 (default enabled).
1272 1389
1273=item B<iso14755_52:> I<boolean> 1390=item B<iso14755_52:> I<boolean>
1274 1391
1275Turn on/off ISO 14755 5.2 mode (default enabled). 1392Turn on/off ISO 14755 5.2 mode (default enabled).
1276 1393
… …
1304=head1 THE SELECTION: SELECTING AND PASTING TEXT 1421=head1 THE SELECTION: SELECTING AND PASTING TEXT
1305 1422
1306The behaviour of text selection and insertion/pasting mechanism is similar 1423The behaviour of text selection and insertion/pasting mechanism is similar
1307to I<xterm>(1). 1424to I<xterm>(1).
1308 1425
1309=over 4 1426=over
1310 1427
1311=item B<Selecting>: 1428=item B<Selecting>:
1312 1429
1313Left click at the beginning of the region, drag to the end of the region 1430Left click at the beginning of the region, drag to the end of the region
1314and release; Right click to extend the marked region; Left double-click 1431and release; Right click to extend the marked region; Left double-click
… …
1329B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1446B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1330 1447
1331Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1448Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1332inserted too. 1449inserted too.
1333 1450
1451rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1452<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1453binding causes the value of the internal selection to be copied to the
1454CLIPBOARD selection, while the second binding causes the value of the
1455CLIPBOARD selection to be inserted.
1456
1334=back 1457=back
1335 1458
1336=head1 CHANGING FONTS 1459=head1 CHANGING FONTS
1337 1460
1338Changing fonts (or font sizes, respectively) via the keypad is not yet 1461Changing fonts (or font sizes, respectively) via the keypad is not yet
… …
1355and character codes using the keyboard. It consists of 4 parts. The 1478and character codes using the keyboard. It consists of 4 parts. The
1356first part is available if rxvt-unicode has been compiled with 1479first part is available if rxvt-unicode has been compiled with
1357C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1480C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1358with C<--enable-iso14755>. 1481with C<--enable-iso14755>.
1359 1482
1360=over 4 1483=over
1361 1484
1362=item * 5.1: Basic method 1485=item * 5.1: Basic method
1363 1486
1364This allows you to enter unicode characters using their hexcode. 1487This allows you to enter unicode characters using their hexcode.
1365 1488
… …
1419B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1542B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1420it can be seen via the I<who(1)> command, and can accept messages. To 1543it can be seen via the I<who(1)> command, and can accept messages. To
1421allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1544allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1422on some systems or setgid to root or to some other group on others. 1545on some systems or setgid to root or to some other group on others.
1423 1546
1424=head1 COLORS AND GRAPHICS 1547=head1 COLOURS AND GRAPHICS
1425 1548
1426In addition to the default foreground and background colours, 1549In addition to the default foreground and background colours,
1427B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1550B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1428high-intensity bold/blink versions of the same). Here is a list of the 1551high-intensity (potentially bold/blink) versions of the same, and 72 (or
1429colours with their names. 1552240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1553cube plus a 8 (24) colour greyscale ramp.
1554
1555B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1556C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1557number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1558colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
155924-bit colour space. When indexing collisions happen, the nearest old colour in
1560the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1561use many similar 24-bit colours. It's typically not a problem in common
1562scenarios.
1563
1564Here is a list of the ANSI colours with their names.
1430 1565
1431=begin table 1566=begin table
1432 1567
1433 B<color0> (black) = Black 1568 B<color0> (black) = Black
1434 B<color1> (red) = Red3 1569 B<color1> (red) = Red3
… …
1454It is also possible to specify the colour values of B<foreground>, 1589It is also possible to specify the colour values of B<foreground>,
1455B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1590B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1456a number 0-15, as a convenient shorthand to reference the colour name of 1591a number 0-15, as a convenient shorthand to reference the colour name of
1457color0-color15. 1592color0-color15.
1458 1593
1459In addition to the colours defined above, @@RXVT_NAME@@ offers an 1594The following text gives values for the standard 88 colour mode (and
1460additional 72 colours. The first 64 of those (with indices 16 to 79) 1595values for the 256 colour mode in parentheses).
1461consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146216>), followed by 8 additional shades of gray (with indices 80 to 87).
1463 1596
1597The RGB cube uses indices 16..79 (16..231) using the following formulas:
1598
1599 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1600 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1601
1602The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1603steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1604the RGB cube.
1605
1464Together, all those colours implement the 88 colour xterm colours. Only 1606Together, all those colours implement the 88 (256) colour xterm
1465the first 16 can be changed using resources currently, the rest can only 1607colours. Only the first 16 can be changed using resources currently, the
1466be changed via command sequences ("escape codes"). 1608rest can only be changed via command sequences ("escape codes").
1609
1610Applications are advised to use terminfo or command sequences to discover
1611number and RGB values of all colours (yes, you can query this...).
1467 1612
1468Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1613Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1469always swapping the foreground/background colours. This is in contrast to 1614always swapping the foreground/background colours. This is in contrast to
1470I<xterm>(1) where the colours are only swapped if they have not otherwise 1615I<xterm>(1) where the colours are only swapped if they have not otherwise
1471been specified. For example, 1616been specified. For example,
1472 1617
1473=over 4
1474
1475=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1618 @@RXVT_NAME@@ -fg Black -bg White -rv
1476 1619
1477would yield White on Black, while on I<xterm>(1) it would yield Black 1620would yield White on Black, while on I<xterm>(1) it would yield Black on
1478on White. 1621White.
1479
1480=back
1481 1622
1482=head2 ALPHA CHANNEL SUPPORT 1623=head2 ALPHA CHANNEL SUPPORT
1483 1624
1484If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1625If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1485their act together, rxvt-unicode will do it's own alpha channel management: 1626their act together, rxvt-unicode will do its own alpha channel management:
1486 1627
1487You can prefix any color with an opaquenes percentage enclosed in 1628You can prefix any colour with an opaqueness percentage enclosed in
1488brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1629brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1489(0-100) that specifies the opacity of the color, where C<0> is completely 1630(0-100) that specifies the opacity of the colour, where C<0> is completely
1490transparent and C<100> is completely opaque. For example, C<[50]red> is a 1631transparent and C<100> is completely opaque. For example, C<[50]red> is a
1491half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1632half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1492is the recommended format to specify transparency values, and works with 1633is the recommended format to specify transparency values, and works with
1493all ways to specify a colour. 1634all ways to specify a colour.
1494 1635
… …
1527 1668
1528=head1 ENVIRONMENT 1669=head1 ENVIRONMENT
1529 1670
1530B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1671B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1531 1672
1532=over 4 1673=over
1533 1674
1534=item B<TERM> 1675=item B<TERM>
1535 1676
1536Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1677Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1537resources or on the command line. 1678resources or on the command line.
… …
1572 1713
1573=item B<SHELL> 1714=item B<SHELL>
1574 1715
1575The shell to be used for command execution, defaults to C</bin/sh>. 1716The shell to be used for command execution, defaults to C</bin/sh>.
1576 1717
1577=item B<RXVT_SOCKET> 1718=item B<RXVT_SOCKET> [I<sic>]
1578 1719
1579The unix domain socket path used by @@RXVT_NAME@@c(1) and 1720The unix domain socket path used by @@RXVT_NAME@@c(1) and
1580@@RXVT_NAME@@d(1). 1721@@RXVT_NAME@@d(1).
1581 1722
1582Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1723Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1724
1725=item B<URXVT_PERL_LIB>
1726
1727Additional F<:>-separated library search path for perl extensions. Will be
1728searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1729directory.
1730
1731=item B<URXVT_PERL_VERBOSITY>
1732
1733See L<@@RXVT_NAME@@perl>(3).
1583 1734
1584=item B<HOME> 1735=item B<HOME>
1585 1736
1586Used to locate the default directory for the unix domain socket for 1737Used to locate the default directory for the unix domain socket for
1587daemon communications and to locate various resource files (such as 1738daemon communications and to locate various resource files (such as
1588C<.Xdefaults>) 1739C<.Xdefaults>)
1589 1740
1590=item B<XAPPLRESDIR> 1741=item B<XAPPLRESDIR>
1591 1742
1592Directory where various X resource files are being located. 1743Directory where application-specific X resource files are located.
1593 1744
1594=item B<XENVIRONMENT> 1745=item B<XENVIRONMENT>
1595 1746
1596If set and accessible, gives the name of a X resource file to be loaded by 1747If set and accessible, gives the name of a X resource file to be loaded by
1597@@RXVT_NAME@@. 1748@@RXVT_NAME@@.
1598 1749
1599=back 1750=back
1600 1751
1601=head1 FILES 1752=head1 FILES
1602 1753
1603=over 4 1754=over
1604 1755
1605=item B</usr/lib/X11/rgb.txt> 1756=item B</usr/lib/X11/rgb.txt>
1606 1757
1607Color names. 1758Colour names.
1608 1759
1609=back 1760=back
1610 1761
1611=head1 SEE ALSO 1762=head1 SEE ALSO
1612 1763
1764@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1613@@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) 1765@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1614 1766
1615=head1 CURRENT PROJECT COORDINATOR 1767=head1 CURRENT PROJECT COORDINATOR
1616 1768
1617=over 4 1769=over
1618 1770
1619=item Project Coordinator 1771=item Project Coordinator
1620 1772
1621Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1773Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1622 1774
1623L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1775L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1624 1776
1625=back 1777=back
1626 1778
1627=head1 AUTHORS 1779=head1 AUTHORS
1628 1780
1629=over 4 1781=over
1630 1782
1631=item John Bovey 1783=item John Bovey
1632 1784
1633University of Kent, 1992, wrote the original Xvt. 1785University of Kent, 1992, wrote the original Xvt.
1634 1786
1635=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1787=item Rob Nation <nation@rocket.sanders.lockheed.com>
1636 1788
1637very heavily modified Xvt and came up with Rxvt 1789very heavily modified Xvt and came up with Rxvt
1638 1790
1639=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1791=item Angelo Haritsis <ah@doc.ic.ac.uk>
1640 1792
1641wrote the Greek Keyboard Input (no longer in code) 1793wrote the Greek Keyboard Input (no longer in code)
1642 1794
1643=item mj olesen L<< <olesen@me.QueensU.CA> >> 1795=item mj olesen <olesen@me.QueensU.CA>
1644 1796
1645Wrote the menu system. 1797Wrote the menu system.
1646 1798
1647Project Coordinator (changes.txt 2.11 to 2.21) 1799Project Coordinator (changes.txt 2.11 to 2.21)
1648 1800
1649=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1801=item Oezguer Kesim <kesim@math.fu-berlin.de>
1650 1802
1651Project Coordinator (changes.txt 2.21a to 2.4.5) 1803Project Coordinator (changes.txt 2.21a to 2.4.5)
1652 1804
1653=item Geoff Wing L<< <gcw@pobox.com> >> 1805=item Geoff Wing <gcw@pobox.com>
1654 1806
1655Rewrote screen display and text selection routines. 1807Rewrote screen display and text selection routines.
1656 1808
1657Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1809Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1658 1810
1659=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1811=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1660 1812
1661Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1813Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1662extension, random hacks, numerous bugfixes and extensions. 1814extension, random hacks, numerous bugfixes and extensions.
1663 1815
1664Project Coordinator (Changes 1.0 -) 1816Project Coordinator (Changes 1.0 -)
1665 1817
1666=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1818=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1667 1819
1668Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1820pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1669 1821
1670=back 1822=back
1671 1823

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines