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.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs.
Revision 1.255 by root, Sat Jul 24 11:00:58 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
95=item B<-display> I<displayname> 95=item B<-display> I<displayname>
96 96
97Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
98respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
99B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
111=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
112 118
113Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
114 120
115=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
… …
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
… …
340 304
341=item B<-bl> 305=item B<-bl>
342 306
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344if honoured by the WM, the rxvt-unicode window will not have window 308if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
346 311
347=item B<-override-redirect> 312=item B<-override-redirect>
348 313
349Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
351 321
352=item B<-sbg> 322=item B<-sbg>
353 323
354Compile 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
355drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
… …
359=item B<-lsp> I<number> 329=item B<-lsp> I<number>
360 330
361Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
363B<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>.
364 341
365=item B<-tn> I<termname> 342=item B<-tn> I<termname>
366 343
367This 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
368B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
… …
403=item B<-pt> I<style> 380=item B<-pt> I<style>
404 381
405Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
406B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
407 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
408=item B<-im> I<text> 388=item B<-im> I<text>
409 389
410Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
411 391
412=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
… …
426Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
427button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
428in-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
429the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
430 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
431=item B<-insecure> 421=item B<-insecure>
432 422
433Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
434sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
435info. 425info.
… …
447 437
448=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
449 439
450Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
451B<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>.
452 450
453=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
454 452
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 454will 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 455it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 456user; resource B<hold>.
457
458=item B<-cd> I<path>
459
460Sets the working directory for the shell (or the command specified via
461B<-e>). The I<path> must be an absolute path and it must exist for
462@@RXVT_NAME@@ to start; resource B<chdir>.
459 463
460=item B<-xrm> I<string> 464=item B<-xrm> I<string>
461 465
462Works like the X Toolkit option of the same name, by adding the I<string> 466Works 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 467as if it were specified in a resource file. Resource values specified this
… …
547You can set and change the resources using X11 tools like B<xrdb>. Many 551You 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 552distribution do also load settings from the B<~/.Xresources> file when X
549starts. @@RXVT_NAME@@ will consult the following files/resources in order, 553starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550with later settings overwriting earlier ones: 554with later settings overwriting earlier ones:
551 555
552 1. system-wide app-defaults file, either locale-dependent OR global
553 2. app-defaults file in $XAPPLRESDIR 556 1. app-defaults file in $XAPPLRESDIR
557 2. $HOME/.Xdefaults
554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 558 3. RESOURCE_MANAGER property on root-window of screen 0
555 4. SCREEN_RESOURCES for the current screen 559 4. SCREEN_RESOURCES property on root-window of the current screen
556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 560 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline 561 6. resources specified via -xrm on the commandline
558 562
559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 563Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 564names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
565be used. Command-line arguments can be used to override resource 569be used. Command-line arguments can be used to override resource
566settings. The following resources are supported (you might want to 570settings. The following resources are supported (you might want to
567check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
568extensions not documented here): 572extensions not documented here):
569 573
570=over 4 574=over
571 575
572=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
573 577
574Compile I<xft>: Attempt to find a visual with the given bit depth; 578Compile I<xft>: Attempt to find a visual with the given bit depth;
575option B<-depth>. 579option B<-depth>.
… …
601Use the specified colour for the colour value I<n>, where 0-7 605Use the specified colour for the colour value I<n>, where 0-7
602corresponds to low-intensity (normal) colours and 8-15 corresponds to 606corresponds to low-intensity (normal) colours and 8-15 corresponds to
603high-intensity (bold = bright foreground, blink = bright background) 607high-intensity (bold = bright foreground, blink = bright background)
604colours. The canonical names are as follows: 0=black, 1=red, 2=green, 608colours. 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 6093=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
606names used are listed in the B<COLORS AND GRAPHICS> section. 610names used are listed in the B<COLOURS AND GRAPHICS> section.
607 611
608Colours higher than 15 cannot be set using resources (yet), but can be 612Colours higher than 15 cannot be set using resources (yet), but can be
609changed using an escape command (see @@RXVT_NAME@@(7)). 613changed using an escape command (see @@RXVT_NAME@@(7)).
610 614
611Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 615Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
622=item B<colorUL:> I<colour> 626=item B<colorUL:> I<colour>
623 627
624Use the specified colour to display underlined characters when the 628Use the specified colour to display underlined characters when the
625foreground colour is the default. 629foreground colour is the default.
626 630
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> 631=item B<underlineColor:> I<colour>
633 632
634If set, use the specified colour as the colour for the underline 633If set, use the specified colour as the colour for the underline
635itself. If unset, use the foreground colour. 634itself. If unset, use the foreground colour.
635
636=item B<highlightColor:> I<colour>
637
638If set, use the specified colour as the background for highlighted
639characters. If unset, use reverse video.
640
641=item B<highlightTextColor:> I<colour>
642
643If set and highlightColor is set, use the specified colour as the
644foreground for highlighted characters.
636 645
637=item B<cursorColor:> I<colour> 646=item B<cursorColor:> I<colour>
638 647
639Use the specified colour for the cursor. The default is to use the 648Use the specified colour for the cursor. The default is to use the
640foreground colour; option B<-cr>. 649foreground colour; option B<-cr>.
… …
647 656
648=item B<reverseVideo:> I<boolean> 657=item B<reverseVideo:> I<boolean>
649 658
650B<True>: simulate reverse video by foreground and background colours; 659B<True>: simulate reverse video by foreground and background colours;
651option B<-rv>. B<False>: regular screen colours [default]; option 660option B<-rv>. B<False>: regular screen colours [default]; option
652B<+rv>. See note in B<COLORS AND GRAPHICS> section. 661B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653 662
654=item B<jumpScroll:> I<boolean> 663=item B<jumpScroll:> I<boolean>
655 664
656B<True>: specify that jump scrolling should be used. When receiving lots 665B<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 666of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
671 680
672B<False>: specify that everything is to be displayed, even 681B<False>: specify that everything is to be displayed, even
673if the refresh is too fast for the human eye to read anything (or the 682if the refresh is too fast for the human eye to read anything (or the
674monitor to display anything); option B<+ss>. 683monitor to display anything); option B<+ss>.
675 684
676=item B<transparent:> I<boolean>
677
678Turn on/off illusion of a transparent window background.
679
680B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
681future versions.
682
683I<Please address all transparency related issues to Sasha Vasko at
684sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
685
686=item B<fading:> I<number> 685=item B<fading:> I<number>
687 686
688Fade the text by the given percentage when focus is lost; option B<-fade>. 687Fade the text by the given percentage when focus is lost; option B<-fade>.
689 688
690=item B<fadeColor:> I<colour> 689=item B<fadeColor:> I<colour>
691 690
692Fade to this colour, when fading is used (see B<fading:>). The default 691Fade to this colour, when fading is used (see B<fading:>). The default
693colour is black; option B<-fadecolor>. 692colour is black; option B<-fadecolor>.
694 693
695=item B<tintColor:> I<colour> 694=item B<iconFile:> I<file>
696 695
697Tint the transparent background pixmap with the given colour; option 696Set 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 697
714=item B<scrollColor:> I<colour> 698=item B<scrollColor:> I<colour>
715 699
716Use the specified colour for the scrollbar [default #B2B2B2]. 700Use the specified colour for the scrollbar [default #B2B2B2].
717 701
… …
722 706
723=item B<borderColor:> I<colour> 707=item B<borderColor:> I<colour>
724 708
725The colour of the border around the text area and between the scrollbar 709The colour of the border around the text area and between the scrollbar
726and the text. 710and 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 711
758=item B<font:> I<fontlist> 712=item B<font:> I<fontlist>
759 713
760Select the fonts to be used. This is a comma separated list of font names 714Select 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 715that 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 738it is named first) and thus defines the character cell grid to be 9 pixels
785wide and 15 pixels high. 739wide and 15 pixels high.
786 740
787The second font is just used to add additional unicode characters not in 741The second font is just used to add additional unicode characters not in
788the base font, likewise the third, which is unfortunately non-bold, but 742the 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 743the bold version of the font does contain fewer characters, so this is a
790useful supplement. 744useful supplement.
791 745
792The third font is an Xft font with aliasing turned off, and the characters 746The 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 747are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
794contains other characters, but we are not interested in them. 748contains other characters, but we are not interested in them.
… …
845=item B<urgentOnBell:> I<boolean> 799=item B<urgentOnBell:> I<boolean>
846 800
847B<True>: set the urgency hint for the wm on receipt of a bell character. 801B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default]. 802B<False>: do not set the urgency hint [default].
849 803
804@@RXVT_NAME@@ resets the urgency hint on every focus change.
805
850=item B<visualBell:> I<boolean> 806=item B<visualBell:> I<boolean>
851 807
852B<True>: use visual bell on receipt of a bell character; option B<-vb>. 808B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853B<False>: no visual bell [default]; option B<+vb>. 809B<False>: no visual bell [default]; option B<+vb>.
854 810
… …
856 812
857B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 813B<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 814the shell; option B<-ls>. B<False>: start as a normal sub-shell
859[default]; option B<+ls>. 815[default]; option B<+ls>.
860 816
817=item B<multiClickTime:> I<number>
818
819Specify the maximum time in milliseconds between multi-click select
820events. The default is 500 milliseconds; option B<-mc>.
821
861=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
862 823
863B<True>: inhibit writing record into the system log file B<utmp>; 824B<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> 825option B<-ut>. B<False>: write record into the system log file B<utmp>
865[default]; option B<+ut>. 826[default]; option B<+ut>.
… …
882=item B<scrollstyle:> I<mode> 843=item B<scrollstyle:> I<mode>
883 844
884Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 845Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885the author's favourite. 846the author's favourite.
886 847
848=item B<thickness:> I<number>
849
850Set the scrollbar width in pixels.
851
887=item B<scrollBar:> I<boolean> 852=item B<scrollBar:> I<boolean>
888 853
889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 854B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
890disable the scrollbar; option B<+sb>. 855disable the scrollbar; option B<+sb>.
891 856
… …
910B<False>: do not scroll to bottom when tty receives output; option 875B<False>: do not scroll to bottom when tty receives output; option
911B<+si>. 876B<+si>.
912 877
913=item B<scrollWithBuffer:> I<boolean> 878=item B<scrollWithBuffer:> I<boolean>
914 879
915B<True>: scroll with scrollback buffer when tty receives new lines (and 880B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
916B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 881try to show the same lines) and B<scrollTtyOutput> is False; option
917with scrollback buffer when tty receives new lines; option B<+sw>. 882B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
883new lines; option B<+sw>.
918 884
919=item B<scrollTtyKeypress:> I<boolean> 885=item B<scrollTtyKeypress:> I<boolean>
920 886
921B<True>: scroll to bottom when a non-special key is pressed. Special keys 887B<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 888are 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 889are 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>. 890bottom when a non-special key is pressed; option B<+sk>.
925 891
926=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
927 893
928Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
929resource is limited on most machines to 65535; option B<-sl>.
930 895
931=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
932 897
933Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
934option B<-b>. 899option B<-b>.
… …
978=item B<cursorBlink:> I<boolean> 943=item B<cursorBlink:> I<boolean>
979 944
980B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 945B<True>: blink the cursor. B<False>: do not blink the cursor [default];
981option B<-bc>. 946option B<-bc>.
982 947
948=item B<cursorUnderline:> I<boolean>
949
950B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
951option B<-uc>.
952
983=item B<pointerBlank:> I<boolean> 953=item B<pointerBlank:> I<boolean>
984 954
985B<True>: blank the pointer when a key is pressed or after a set number 955B<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 956of seconds of inactivity. B<False>: the pointer is always visible
987[default]. 957[default].
… …
992 962
993=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
994 964
995Mouse pointer background colour. 965Mouse pointer background colour.
996 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
997=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
998 974
999Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
1000large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
1001 977
1002=item B<backspacekey:> I<string> 978=item B<backspacekey:> I<string>
1003 979
1004The string to send when the backspace key is pressed. If set to B<DEC> 980The 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> 981or 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 982(code 8) - which can be reversed with the appropriate DEC private mode
1007escape sequence. 983escape sequence.
1008 984
1009=item B<deletekey:> I<string> 985=item B<deletekey:> I<string>
1010 986
… …
1027 1003
1028B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1029 1005
1030=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
1031 1007
1032B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1033 1009
1034=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
1035 1011
1036I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
1037 1013
… …
1055 1031
1056Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1057button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
1058the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1059 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1060=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1061 1041
1062Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1063echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
1064abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1065through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1066write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1067default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
… …
1085 1065
1086=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1087 1067
1088Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1089 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1090=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1091 1076
1092Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1079scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1080to/from the secondary screen will instead scroll the screen up.
1096 1081
1097=item B<hold>: I<boolean> 1082=item B<hold>: I<boolean>
1098 1083
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1084Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1085will 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 1086it exits. Instead, it will wait till it is being killed or closed by the
1102user. 1087user.
1103 1088
1089=item B<chdir>: I<path>
1090
1091Sets the working directory for the shell (or the command specified via
1092B<-e>). The I<path> must be an absolute path and it must exist for
1093@@RXVT_NAME@@ to start. If it isn't specified then the current working
1094directory will be used; option B<-cd>.
1095
1104=item B<keysym.>I<sym>: I<string> 1096=item B<keysym.>I<sym>: I<action>
1105 1097
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1098Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1107intervening resource name B<keysym.> cannot be omitted. 1099resource name B<keysym.> cannot be omitted.
1108 1100
1109The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1101Using this resource, you can map key combinations such as
1110any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1102C<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>, 1103string 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>, 1104terminal scroll up or down the way you want it, or any other thing an
1113B<2>, B<3>, B<4>, B<5>. 1105extension might provide.
1106
1107The key combination that triggers the action, I<sym>, has the following format:
1108
1109 (modifiers-)key
1110
1111Where I<modifiers> can be any combination of the following full or
1112abbreviated modifier names:
1113
1114=begin table
1115
1116 B<ISOLevel3> B<I>
1117 B<AppKeypad> B<K>
1118 B<Control> B<C>
1119 B<NumLock> B<N>
1120 B<Shift> B<S>
1121 B<Meta> B<M> I<or> B<A>
1122 B<Lock> B<L>
1123 B<Mod1> B<1>
1124 B<Mod2> B<2>
1125 B<Mod3> B<3>
1126 B<Mod4> B<4>
1127 B<Mod5> B<5>
1128
1129=end table
1114 1130
1115The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The 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 1132whatever 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 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1118current application keymap mode state. 1134current application keymap mode state.
1119 1135
1120The spellings of I<key> can be obtained by using B<xev>(1) command or 1136Due the the large number of modifier combinations, a key mapping will
1121searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1137match if I<at least> the specified identifiers are being set, and no other
1138key mappings with those and more bits are being defined. That means that
1139defining a mapping for C<a> will automatically provide definitions for
1140C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1141themselves. See the C<builtin:> action, below, for a way to work around
1142this when this is a problem.
1143
1144The spelling of I<key> depends on your implementation of X. An easy way to
1145find a key name is to use the B<xev>(1) command. You can find a list by
1146looking 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 1147the 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 1148value (B<0x0000 - 0xFFFF>).
1124performed in an exact manner; however, the closest match is assured.
1125 1149
1126I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1150As with any resource value, the I<action> string may contain backslash
1151escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1127number), see RESOURCES in C<man 7 X> for futher details. 1152number), see RESOURCES in C<man 7 X> for further details.
1128 1153
1129You can define a range of keysyms in one shot by providing a I<string> 1154An action starts with an action prefix that selects a certain type
1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1155of action, followed by a colon. An action string without colons is
1156interpreted as a literal string to pass to the tty (as if it was
1157prefixed with C<string:>).
1158
1159The following action prefixes are known - extensions can provide
1160additional prefixes:
1161
1162=over
1163
1164=item string:STRING
1165
1166If the I<action> starts with C<string:> (or otherwise contains no colons),
1167then the remaining C<STRING> will be passed to the program running in the
1168terminal. For example, you could replace whatever Shift-Tab outputs by the
1169string C<echo rm -rf /> followed by a newline:
1170
1171 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1172
1173This could in theory be used to completely redefine your keymap.
1174
1175In addition, for actions of this type, you can define a range of
1176keysyms in one shot by loading the C<keysym-list> perl extension and
1177providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1131should be a character not used by the strings. 1178the delimiter `/' should be a character not used by the strings.
1132 1179
1133Its usage can be demonstrated by an example: 1180Its usage can be demonstrated by an example:
1134 1181
1135 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1136 1183
1137The above line is equivalent to the following three lines: 1184The above line is equivalent to the following three lines:
1138 1185
1139 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1140 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1141 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1142 1189
1190=item command:STRING
1191
1143If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1192If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1144is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1193is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1194the opposite of C<string:> - instead of sending it to the program running
1195in the terminal, it will be treated as if it were program output). This is
1196most useful to feed command sequences into @@RXVT_NAME@@.
1197
1145example the following means "change the current locale to C<zh_CN.GBK> 1198For example the following means "change the current locale to C<zh_CN.GBK>
1146when Control-Meta-c is being pressed": 1199when Control-Meta-c is being pressed":
1147 1200
1148 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1201 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149 1202
1150If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1203The 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) 1204the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1152manpage. For example, the F<selection> extension (activated via 1205font-switching at runtime:
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154 1206
1155 URxvt.keysym.M-C-c: perl:selection:rot13 1207 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1208 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1156 1209
1157Due the the large number of modifier combinations, a defined key mapping 1210Other 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 1211info):
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 1212
1164Unfortunately, this will override built-in key mappings. For example 1213 URxvt.keysym.M-C-3: command:\033[8;25;80t
1214 URxvt.keysym.M-C-4: command:\033[8;48;110t
1215
1216=item builtin:
1217
1218The builtin action is the action that @@RXVT_NAME@@ would execute if no
1219key binding existed for the key combination. The obvious use is to undo
1220the effect of existing bindings. The not so obvious use is to reinstate
1221bindings when another binding overrides too many modifiers.
1222
1165if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1223For 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 1224@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1167user-defined keymap using the C<builtin:> replacement: 1225"holes" into the user-defined keymap using the C<builtin:> replacement:
1168 1226
1169 URxvt.keysym.Insert: <my insert key sequence> 1227 URxvt.keysym.Insert: <my insert key sequence>
1170 URxvt.keysym.S-Insert: builtin: 1228 URxvt.keysym.S-Insert: builtin:
1171 1229
1172The first line defines a mapping for C<Insert> and I<any> combination 1230The first line defines a mapping for C<Insert> and I<any> combination
1173of modifiers. The second line re-establishes the default mapping for 1231of modifiers. The second line re-establishes the default mapping for
1174C<Shift-Insert>. 1232C<Shift-Insert>.
1175 1233
1176The following example will map Control-Meta-1 and Control-Meta-2 to 1234=item builtin-string:
1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1178font-switching at runtime:
1179 1235
1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1236This action is mainly useful to restore string mappings for keys that
1181 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1237have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1238difficult to explain - basically, this action will send the string to the
1239application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1240action for it.
1182 1241
1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1242An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1184info): 1243selection when you press C<Shift-Insert>. With the following bindings, it
1244would instead emit the (undocumented, but what applications running in the
1245terminal might expect) sequence C<ESC [ 2 $> instead:
1185 1246
1186 URxvt.keysym.M-C-3: command:\033[8;25;80t 1247 URxvt.keysym.S-Insert: builtin-string:
1187 URxvt.keysym.M-C-4: command:\033[8;48;110t 1248 URxvt.keysym.C-S-Insert: builtin:
1249
1250The first line disables the paste functionality for that key
1251combination, and the second reinstates the default behaviour for
1252C<Control-Shift-Insert>, which would otherwise be overridden.
1253
1254Similarly, to let applications gain access to the C<C-M-c> (copy to
1255clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1256this:
1257
1258 URxvt.keysym.C-M-c: builtin-string:
1259 URxvt.keysym.C-M-v: builtin-string:
1260
1261=item EXTENSION:STRING
1262
1263An action of this form invokes the action B<STRING>, if any, provided
1264by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1265be loaded automatically if necessary.
1266
1267Not all extensions define actions, but popular extensions that do
1268include the I<selection> and I<matcher> extensions (documented in their
1269own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1270respectively).
1271
1272From the silly examples department, this will rot13-"encrypt"
1273@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1274keyboards:
1275
1276 URxvt.keysym.M-C-c: selection:rot13
1277
1278=item perl:STRING *DEPRECATED*
1279
1280This is a deprecated way of invoking commands provided by perl
1281extensions. It is still supported, but should not be used anymore.
1282
1283=back
1188 1284
1189=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1190 1286
1191=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1192 1288
1193Comma-separated list(s) of perl extension scripts (default: C<default>) to 1289Comma-separated list(s) of perl extension scripts (default: C<default>) to
1194use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1195 1291
1196Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to remove them again, in
1197them. This can be useful to selectively disable some extensions loaded 1293case they had been specified earlier. This can be useful to selectively
1198by default, or specified via the C<perl-ext-common> resource. For 1294disable some extensions loaded by default, or specified via the
1199example, C<default,-selection> will use all the default extension except 1295C<perl-ext-common> resource. For example, C<default,-selection> will use
1200C<selection>. 1296all the default extensions except C<selection>.
1201 1297
1202Extension names can also be followed by an argument in angle brackets 1298To prohibit autoloading of extensions, you can prefix them with C</>,
1203(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299which will make urxvt refuse to automatically load them (this can be
1204searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300overriden, however, by specifying the extension name again without a
1205multiple times with different arguments will pass multiple arguments to 1301prefix, though). This does not prohibit extensions themselves loading
1206the extension. 1302other extensions. For example, C<default,/background> will keep the
1303C<background> extension from being loaded when a background OSC sequence
1304is received.
1305
1306The default set includes the C<selection>, C<option-popup>,
1307C<selection-popup>, C<readline>, C<searchable-scrollback> and
1308C<confirm-paste> extensions, as well as any extensions which are mentioned
1309in B<keysym> resources.
1310
1311Any extension such that a corresponding resource is given on the
1312command line is automatically appended to B<perl-ext>.
1207 1313
1208Each extension is looked up in the library directories, loaded if 1314Each extension is looked up in the library directories, loaded if
1209necessary, and bound to the current terminal instance. 1315necessary, and bound to the current terminal instance. When the library
1316search path contains multiple extension files of the same name, then the
1317first one found will be used.
1210 1318
1211If both of these resources are the empty string, then the perl 1319If both of these resources are the empty string, then the perl interpreter
1212interpreter will not be initialized. The idea behind two options is that 1320will 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 1321B<perl-ext-common> will be used for extensions that should be available to
1214all instances, while B<perl-ext> is used for specific instances. 1322all instances, while B<perl-ext> is used for specific instances.
1215 1323
1216=item B<perl-eval>: I<string> 1324=item B<perl-eval>: I<string>
1217 1325
1218Perl code to be evaluated when all extensions have been registered. See 1326Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1327the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1328
1222=item B<perl-lib>: I<path> 1329=item B<perl-lib>: I<path>
1223 1330
1224Colon-separated list of additional directories that hold extension 1331Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1332scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1226@@RXVT_NAME@@ will first look in these directories and then in 1333in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1334lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1335
1230See the @@RXVT_NAME@@perl(3) manpage. 1336See the @@RXVT_NAME@@perl(3) manpage.
1231 1337
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1338=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1339
… …
1237=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1343=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1238 1344
1239Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1345Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1240for details. 1346for details.
1241 1347
1242=item B<searchable-scrollback:> I<keysym> 1348=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1243 1349
1244Sets the hotkey that starts the incremental scrollback buffer search 1350This resource is deprecated and will be removed. Use a B<keysym> resource
1245(default: C<M-s>). 1351instead, e.g.:
1246 1352
1353 URxvt.keysym.M-s: searchable-scrollback:start
1354
1247=item B<urlLauncher>: I<string> 1355=item B<url-launcher>: I<string>
1248 1356
1249Specifies the program to be started with a URL argument. Used by the 1357Specifies the program to be started with a URL argument. Used by the
1250C<selection-popup> and C<matcher> perl extensions. 1358C<selection-popup> and C<matcher> perl extensions.
1251 1359
1252=item B<transient-for>: I<windowid> 1360=item B<transient-for>: I<windowid>
… …
1255 1363
1256=item B<override-redirect>: I<boolean> 1364=item B<override-redirect>: I<boolean>
1257 1365
1258Compile I<frills>: Sets override-redirect for the terminal window, making 1366Compile I<frills>: Sets override-redirect for the terminal window, making
1259it almost invisible to window managers; option B<-override-redirect>. 1367it almost invisible to window managers; option B<-override-redirect>.
1368
1369=item B<iso14755:> I<boolean>
1370
1371Turn on/off ISO 14755 (default enabled).
1260 1372
1261=item B<iso14755_52:> I<boolean> 1373=item B<iso14755_52:> I<boolean>
1262 1374
1263Turn on/off ISO 14755 5.2 mode (default enabled). 1375Turn on/off ISO 14755 5.2 mode (default enabled).
1264 1376
… …
1292=head1 THE SELECTION: SELECTING AND PASTING TEXT 1404=head1 THE SELECTION: SELECTING AND PASTING TEXT
1293 1405
1294The behaviour of text selection and insertion/pasting mechanism is similar 1406The behaviour of text selection and insertion/pasting mechanism is similar
1295to I<xterm>(1). 1407to I<xterm>(1).
1296 1408
1297=over 4 1409=over
1298 1410
1299=item B<Selecting>: 1411=item B<Selecting>:
1300 1412
1301Left click at the beginning of the region, drag to the end of the region 1413Left 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 1414and 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. 1429B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1318 1430
1319Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1431Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1320inserted too. 1432inserted too.
1321 1433
1434rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1435<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1436binding causes the value of the internal selection to be copied to the
1437CLIPBOARD selection, while the second binding causes the value of the
1438CLIPBOARD selection to be inserted.
1439
1322=back 1440=back
1323 1441
1324=head1 CHANGING FONTS 1442=head1 CHANGING FONTS
1325 1443
1326Changing fonts (or font sizes, respectively) via the keypad is not yet 1444Changing fonts (or font sizes, respectively) via the keypad is not yet
… …
1343and character codes using the keyboard. It consists of 4 parts. The 1461and character codes using the keyboard. It consists of 4 parts. The
1344first part is available if rxvt-unicode has been compiled with 1462first part is available if rxvt-unicode has been compiled with
1345C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1463C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1346with C<--enable-iso14755>. 1464with C<--enable-iso14755>.
1347 1465
1348=over 4 1466=over
1349 1467
1350=item * 5.1: Basic method 1468=item * 5.1: Basic method
1351 1469
1352This allows you to enter unicode characters using their hexcode. 1470This allows you to enter unicode characters using their hexcode.
1353 1471
… …
1407B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1525B<@@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 1526it 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 1527allow 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. 1528on some systems or setgid to root or to some other group on others.
1411 1529
1412=head1 COLORS AND GRAPHICS 1530=head1 COLOURS AND GRAPHICS
1413 1531
1414In addition to the default foreground and background colours, 1532In addition to the default foreground and background colours,
1415B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1533B<@@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 1534high-intensity (potentially bold/blink) versions of the same, and 72 (or
1417colours with their names. 1535240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1536cube plus a 8 (24) colour greyscale ramp.
1537
1538B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1539C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1540number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1541colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
154224-bit colour space. When indexing collisions happen, the nearest old colour in
1543the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1544use many similar 24-bit colours. It's typically not a problem in common
1545scenarios.
1546
1547Here is a list of the ANSI colours with their names.
1418 1548
1419=begin table 1549=begin table
1420 1550
1421 B<color0> (black) = Black 1551 B<color0> (black) = Black
1422 B<color1> (red) = Red3 1552 B<color1> (red) = Red3
… …
1442It is also possible to specify the colour values of B<foreground>, 1572It is also possible to specify the colour values of B<foreground>,
1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1573B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444a number 0-15, as a convenient shorthand to reference the colour name of 1574a number 0-15, as a convenient shorthand to reference the colour name of
1445color0-color15. 1575color0-color15.
1446 1576
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an 1577The following text gives values for the standard 88 colour mode (and
1448additional 72 colours. The first 64 of those (with indices 16 to 79) 1578values 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 1579
1580The RGB cube uses indices 16..79 (16..231) using the following formulas:
1581
1582 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1583 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1584
1585The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1586steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1587the RGB cube.
1588
1452Together, all those colours implement the 88 colour xterm colours. Only 1589Together, all those colours implement the 88 (256) colour xterm
1453the first 16 can be changed using resources currently, the rest can only 1590colours. Only the first 16 can be changed using resources currently, the
1454be changed via command sequences ("escape codes"). 1591rest can only be changed via command sequences ("escape codes").
1592
1593Applications are advised to use terminfo or command sequences to discover
1594number and RGB values of all colours (yes, you can query this...).
1455 1595
1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1596Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457always swapping the foreground/background colours. This is in contrast to 1597always swapping the foreground/background colours. This is in contrast to
1458I<xterm>(1) where the colours are only swapped if they have not otherwise 1598I<xterm>(1) where the colours are only swapped if they have not otherwise
1459been specified. For example, 1599been specified. For example,
1460 1600
1461=over 4
1462
1463=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1601 @@RXVT_NAME@@ -fg Black -bg White -rv
1464 1602
1465would yield White on Black, while on I<xterm>(1) it would yield Black 1603would yield White on Black, while on I<xterm>(1) it would yield Black on
1466on White. 1604White.
1467
1468=back
1469 1605
1470=head2 ALPHA CHANNEL SUPPORT 1606=head2 ALPHA CHANNEL SUPPORT
1471 1607
1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1608If 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: 1609their act together, rxvt-unicode will do its own alpha channel management:
1474 1610
1475You can prefix any color with an opaquenes percentage enclosed in 1611You can prefix any colour with an opaqueness percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1612brackets, 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 1613(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 1614transparent 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 1615half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with 1616is the recommended format to specify transparency values, and works with
1481all ways to specify a colour. 1617all ways to specify a colour.
1482 1618
… …
1515 1651
1516=head1 ENVIRONMENT 1652=head1 ENVIRONMENT
1517 1653
1518B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1654B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1519 1655
1520=over 4 1656=over
1521 1657
1522=item B<TERM> 1658=item B<TERM>
1523 1659
1524Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1660Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1525resources or on the command line. 1661resources or on the command line.
… …
1553C<--with-terminfo=PATH>. 1689C<--with-terminfo=PATH>.
1554 1690
1555=item B<DISPLAY> 1691=item B<DISPLAY>
1556 1692
1557Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1693Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1558display in its child processes. 1694display in its child processes if C<-display> isn't used to override. It
1695defaults to C<:0> if it doesn't exist.
1559 1696
1560=item B<SHELL> 1697=item B<SHELL>
1561 1698
1562The shell to be used for command execution, defaults to C</bin/sh>. 1699The shell to be used for command execution, defaults to C</bin/sh>.
1563 1700
1564=item B<RXVT_SOCKET> 1701=item B<RXVT_SOCKET> [I<sic>]
1565 1702
1566The unix domain socket path used by @@RXVT_NAME@@c(1) and 1703The unix domain socket path used by @@RXVT_NAME@@c(1) and
1567@@RXVT_NAME@@d(1). 1704@@RXVT_NAME@@d(1).
1568 1705
1569Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1706Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1707
1708=item B<URXVT_PERL_LIB>
1709
1710Additional F<:>-separated library search path for perl extensions. Will be
1711searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1712directory.
1713
1714=item B<URXVT_PERL_VERBOSITY>
1715
1716See L<@@RXVT_NAME@@perl>(3).
1570 1717
1571=item B<HOME> 1718=item B<HOME>
1572 1719
1573Used to locate the default directory for the unix domain socket for 1720Used to locate the default directory for the unix domain socket for
1574daemon communications and to locate various resource files (such as 1721daemon communications and to locate various resource files (such as
1575C<.Xdefaults>) 1722C<.Xdefaults>)
1576 1723
1577=item B<XAPPLRESDIR> 1724=item B<XAPPLRESDIR>
1578 1725
1579Directory where various X resource files are being located. 1726Directory where application-specific X resource files are located.
1580 1727
1581=item B<XENVIRONMENT> 1728=item B<XENVIRONMENT>
1582 1729
1583If set and accessible, gives the name of a X resource file to be loaded by 1730If set and accessible, gives the name of a X resource file to be loaded by
1584@@RXVT_NAME@@. 1731@@RXVT_NAME@@.
1585 1732
1586=back 1733=back
1587 1734
1588=head1 FILES 1735=head1 FILES
1589 1736
1590=over 4 1737=over
1591 1738
1592=item B</usr/lib/X11/rgb.txt> 1739=item B</usr/lib/X11/rgb.txt>
1593 1740
1594Color names. 1741Colour names.
1595 1742
1596=back 1743=back
1597 1744
1598=head1 SEE ALSO 1745=head1 SEE ALSO
1599 1746
1747@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1600@@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) 1748@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1601 1749
1602=head1 CURRENT PROJECT COORDINATOR 1750=head1 CURRENT PROJECT COORDINATOR
1603 1751
1604=over 4 1752=over
1605 1753
1606=item Project Coordinator 1754=item Project Coordinator
1607 1755
1608Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1756Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1609 1757
1610L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1758L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1611 1759
1612=back 1760=back
1613 1761
1614=head1 AUTHORS 1762=head1 AUTHORS
1615 1763
1616=over 4 1764=over
1617 1765
1618=item John Bovey 1766=item John Bovey
1619 1767
1620University of Kent, 1992, wrote the original Xvt. 1768University of Kent, 1992, wrote the original Xvt.
1621 1769
1622=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1770=item Rob Nation <nation@rocket.sanders.lockheed.com>
1623 1771
1624very heavily modified Xvt and came up with Rxvt 1772very heavily modified Xvt and came up with Rxvt
1625 1773
1626=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1774=item Angelo Haritsis <ah@doc.ic.ac.uk>
1627 1775
1628wrote the Greek Keyboard Input (no longer in code) 1776wrote the Greek Keyboard Input (no longer in code)
1629 1777
1630=item mj olesen L<< <olesen@me.QueensU.CA> >> 1778=item mj olesen <olesen@me.QueensU.CA>
1631 1779
1632Wrote the menu system. 1780Wrote the menu system.
1633 1781
1634Project Coordinator (changes.txt 2.11 to 2.21) 1782Project Coordinator (changes.txt 2.11 to 2.21)
1635 1783
1636=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1784=item Oezguer Kesim <kesim@math.fu-berlin.de>
1637 1785
1638Project Coordinator (changes.txt 2.21a to 2.4.5) 1786Project Coordinator (changes.txt 2.21a to 2.4.5)
1639 1787
1640=item Geoff Wing L<< <gcw@pobox.com> >> 1788=item Geoff Wing <gcw@pobox.com>
1641 1789
1642Rewrote screen display and text selection routines. 1790Rewrote screen display and text selection routines.
1643 1791
1644Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1792Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1645 1793
1646=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1794=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1647 1795
1648Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1796Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1649extension, random hacks, numerous bugfixes and extensions. 1797extension, random hacks, numerous bugfixes and extensions.
1650 1798
1651Project Coordinator (Changes 1.0 -) 1799Project Coordinator (Changes 1.0 -)
1652 1800
1653=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1801=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1654 1802
1655Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1803pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1656 1804
1657=back 1805=back
1658 1806

Diff Legend

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