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.154 by ayin, Fri Dec 14 09:06:36 2007 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC

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
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
109this, so watch out]
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
106=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
107 118
108Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
109 120
110=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
116Turn 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>.
117 128
118=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
119 130
120Turn 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>.
121
122=item B<-tr>|B<+tr>
123
124Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126B<-ip> is still accepted as an obsolete alias but will be removed in
127future versions.
128
129I<Please address all transparency related issues to Sasha Vasko at
130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
131 132
132=item B<-fade> I<number> 133=item B<-fade> I<number>
133 134
134Fade 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
135fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
138=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
139 140
140Fade 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
141is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
142 143
143=item B<-tint> I<colour> 144=item B<-icon> I<file>
144 145
145Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
146transparency is enabled with B<-tr>. This only works for 147is used by many window managers, taskbars and pagers to represent the
147non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application window; resource I<iconFile>.
148used to brighten or darken the image in addition to tinting it.
149Please note that certain tint colours can be applied on the server-side,
150thus yielding performance gain of two orders of magnitude. These colours are:
151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
153I<tintColor>. Example:
154
155 @@RXVT_NAME@@ -tr -tint blue -sh 40
156
157=item B<-sh> I<number>
158
159Darken (0 .. 100) or lighten (100 .. 200) the transparent
160background image in addition to (or instead of) tinting it;
161resource I<shading>.
162
163=item B<-blt> I<string>
164
165Specify background blending type. If background pixmap is specified
166at the same time as transparency - such pixmap will be blended over
167transparency image, using method specified. Supported values are :
168B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171alpha-blending. Compile I<afterimage>; resource I<blendType>.
172
173=item B<-blr> I<HxV>
174
175Apply Gaussian Blur with the specified radii to the transparent
176background image. If single number is specified - both vertical and
177horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180resource I<blurRadius>.
181 149
182=item B<-bg> I<colour> 150=item B<-bg> I<colour>
183 151
184Window background colour; resource B<background>. 152Window background colour; resource B<background>.
185 153
186=item B<-fg> I<colour> 154=item B<-fg> I<colour>
187 155
188Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
189
190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
191
192Compile I<afterimage>: Specify image file for the background and also
193optionally specify its scaling with a geometry string. Note you may need to
194add quotes to avoid special shell interpretation of the C<;> in the
195command-line; for more details see resource B<backgroundPixmap>.
196 157
197=item B<-cr> I<colour> 158=item B<-cr> I<colour>
198 159
199The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
200 161
259 220
260=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
261 222
262Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
263 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
264=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
265 230
266Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
267B<utmpInhibit>. 232B<utmpInhibit>.
268 233
272B<visualBell>. 237B<visualBell>.
273 238
274=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
275 240
276Turn on/off scrollbar; resource B<scrollBar>. 241Turn on/off scrollbar; resource B<scrollBar>.
242
243=item B<-sr>|B<+sr>
244
245Put scrollbar on right/left; resource B<scrollBar_right>.
246
247=item B<-st>|B<+st>
248
249Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
250resource B<scrollBar_floating>.
277 251
278=item B<-si>|B<+si> 252=item B<-si>|B<+si>
279 253
280Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
281B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
288=item B<-sw>|B<+sw> 262=item B<-sw>|B<+sw>
289 263
290Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
291This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
292B<scrollWithBuffer>. 266B<scrollWithBuffer>.
293
294=item B<-sr>|B<+sr>
295
296Put scrollbar on right/left; resource B<scrollBar_right>.
297
298=item B<-st>|B<+st>
299
300Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
301resource B<scrollBar_floating>.
302 267
303=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
304 269
305If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
306actual wide characters in the screen buffer, which makes it possible to 271actual wide characters in the screen buffer, which makes it possible to
310 275
311=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
312 277
313Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
314 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
315=item B<-iconic> 284=item B<-iconic>
316 285
317Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
318Alternative form is B<-ic>. 287Alternative form is B<-ic>.
319 288
335 304
336=item B<-bl> 305=item B<-bl>
337 306
338Compile 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.
339if 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
340decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
341 311
342=item B<-override-redirect> 312=item B<-override-redirect>
343 313
344Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
345B<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.
346 321
347=item B<-sbg> 322=item B<-sbg>
348 323
349Compile 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
350drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
354=item B<-lsp> I<number> 329=item B<-lsp> I<number>
355 330
356Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
357the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
358B<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>.
359 341
360=item B<-tn> I<termname> 342=item B<-tn> I<termname>
361 343
362This 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
363B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
398=item B<-pt> I<style> 380=item B<-pt> I<style>
399 381
400Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
401B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
402 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
403=item B<-im> I<text> 388=item B<-im> I<text>
404 389
405Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
406 391
407=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
421Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
422button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
423in-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
424the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
425 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disables (or enabled) 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 omitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePAsteBrackets>.
420
426=item B<-insecure> 421=item B<-insecure>
427 422
428Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
429sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
430info. 425info.
442 437
443=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
444 439
445Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
446B<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>.
447 450
448=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
449 452
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
452it 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
453user; 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>.
454 463
455=item B<-xrm> I<string> 464=item B<-xrm> I<string>
456 465
457Works 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>
458as 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
542You 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
543distribution do also load settings from the B<~/.Xresources> file when X 552distribution do also load settings from the B<~/.Xresources> file when X
544starts. @@RXVT_NAME@@ will consult the following files/resources in order, 553starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545with later settings overwriting earlier ones: 554with later settings overwriting earlier ones:
546 555
547 1. system-wide app-defaults file, either locale-dependent OR global
548 2. app-defaults file in $XAPPLRESDIR 556 1. app-defaults file in $XAPPLRESDIR
557 2. $HOME/.Xdefaults
549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 558 3. RESOURCE_MANAGER property on root-window of screen 0
550 4. SCREEN_RESOURCES for the current screen 559 4. SCREEN_RESOURCES property on root-window of the current screen
551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 560 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline 561 6. resources specified via -xrm on the commandline
553 562
554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 563Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
555names: 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
567=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
568 577
569Compile 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;
570option B<-depth>. 579option B<-depth>.
571 580
581=item B<buffered:> I<boolean>
582
583Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
584On some card/driver combination enabling it slightly decreases
585performance, on most it greatly helps it. The slowdown is small, so it
586should normally be enabled.
587
572=item B<geometry:> I<geom> 588=item B<geometry:> I<geom>
573 589
574Create the window with the specified X window geometry [default 80x24]; 590Create the window with the specified X window geometry [default 80x24];
575option B<-geometry>. 591option B<-geometry>.
576 592
589Use 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
590corresponds to low-intensity (normal) colours and 8-15 corresponds to 606corresponds to low-intensity (normal) colours and 8-15 corresponds to
591high-intensity (bold = bright foreground, blink = bright background) 607high-intensity (bold = bright foreground, blink = bright background)
592colours. 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,
5933=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
594names used are listed in the B<COLORS AND GRAPHICS> section. 610names used are listed in the B<COLOURS AND GRAPHICS> section.
595 611
596Colours 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
597changed using an escape command (see @@RXVT_NAME@@(7)). 613changed using an escape command (see @@RXVT_NAME@@(7)).
598 614
599Colours 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
610=item B<colorUL:> I<colour> 626=item B<colorUL:> I<colour>
611 627
612Use the specified colour to display underlined characters when the 628Use the specified colour to display underlined characters when the
613foreground colour is the default. 629foreground colour is the default.
614 630
615=item B<colorRV:> I<colour>
616
617Use the specified colour as the background for reverse video characters
618when OPTION_HC is disabled (--disable-frills).
619
620=item B<underlineColor:> I<colour> 631=item B<underlineColor:> I<colour>
621 632
622If set, use the specified colour as the colour for the underline 633If set, use the specified colour as the colour for the underline
623itself. 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.
624 645
625=item B<cursorColor:> I<colour> 646=item B<cursorColor:> I<colour>
626 647
627Use 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
628foreground colour; option B<-cr>. 649foreground colour; option B<-cr>.
635 656
636=item B<reverseVideo:> I<boolean> 657=item B<reverseVideo:> I<boolean>
637 658
638B<True>: simulate reverse video by foreground and background colours; 659B<True>: simulate reverse video by foreground and background colours;
639option B<-rv>. B<False>: regular screen colours [default]; option 660option B<-rv>. B<False>: regular screen colours [default]; option
640B<+rv>. See note in B<COLORS AND GRAPHICS> section. 661B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641 662
642=item B<jumpScroll:> I<boolean> 663=item B<jumpScroll:> I<boolean>
643 664
644B<True>: specify that jump scrolling should be used. When receiving lots 665B<True>: specify that jump scrolling should be used. When receiving lots
645of 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
659 680
660B<False>: specify that everything is to be displayed, even 681B<False>: specify that everything is to be displayed, even
661if 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
662monitor to display anything); option B<+ss>. 683monitor to display anything); option B<+ss>.
663 684
664=item B<transparent:> I<boolean>
665
666Turn on/off illusion of a transparent window background.
667
668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669future versions.
670
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
673
674=item B<fading:> I<number> 685=item B<fading:> I<number>
675 686
676Fade 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>.
677 688
678=item B<fadeColor:> I<colour> 689=item B<fadeColor:> I<colour>
679 690
680Fade 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
681colour is black; option B<-fadecolor>. 692colour is black; option B<-fadecolor>.
682 693
683=item B<tintColor:> I<colour> 694=item B<iconFile:> I<file>
684 695
685Tint the transparent background pixmap with the given colour; option 696Set the application icon pixmap; option B<-icon>.
686B<-tint>.
687
688=item B<shading:> I<number>
689
690Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
691in addition to tinting it; option B<-sh>.
692
693=item B<blendType:> I<string>
694
695Specify background blending type; option B<-blt>.
696
697=item B<blurRadius:> I<number>
698
699Apply Gaussian Blurr with the specified radius to the transparent
700background image; option B<-blr>.
701 697
702=item B<scrollColor:> I<colour> 698=item B<scrollColor:> I<colour>
703 699
704Use the specified colour for the scrollbar [default #B2B2B2]. 700Use the specified colour for the scrollbar [default #B2B2B2].
705 701
710 706
711=item B<borderColor:> I<colour> 707=item B<borderColor:> I<colour>
712 708
713The 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
714and the text. 710and the text.
715
716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
717
718Use the specified image file for the background and also
719optionally specify its scaling with a geometry string B<WxH+X+Y>,
720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722centre (percent). A scale of 0 displays the image with tiling. A scale
723of 1 displays the image without any scaling. A scale of 2 to 9 specifies
724an integer number of images in that direction. No image will be magnified
725beyond 10 times its original size. The maximum permitted scale is 1000.
726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are:
728
729 tile force background image to be tiled and not scaled. Equivalent to 0x0,
730 propscale will scale image keeping proportions,
731 auto will scale image to match window size. Equivalent to 100x100;
732 hscale will scale image horizontally to the window size;
733 vscale will scale image vertically to the window size;
734 scale will scale image to match window size;
735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves.
737
738If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any
740other blending type, specified with B<-blt "type"> option.
741
742=item B<path:> I<path>
743
744Specify the colon-delimited search path for finding background image files.
745 711
746=item B<font:> I<fontlist> 712=item B<font:> I<fontlist>
747 713
748Select 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
749that 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
772it 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
773wide and 15 pixels high. 739wide and 15 pixels high.
774 740
775The 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
776the base font, likewise the third, which is unfortunately non-bold, but 742the base font, likewise the third, which is unfortunately non-bold, but
777the 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
778useful supplement. 744useful supplement.
779 745
780The 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
781are 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
782contains other characters, but we are not interested in them. 748contains other characters, but we are not interested in them.
811option B<-is>, the default), bold/blink font styles imply high 777option B<-is>, the default), bold/blink font styles imply high
812intensity foreground/background colours. Disabling this option (B<False>, 778intensity foreground/background colours. Disabling this option (B<False>,
813option B<+is>) disables this behaviour, the high intensity colours are not 779option B<+is>) disables this behaviour, the high intensity colours are not
814reachable. 780reachable.
815 781
816=item B<selectstyle:> I<mode>
817
818Set mouse selection style to B<old> which is 2.20, B<oldword> which
819is xterm style with 2.20 old word selection, or anything else which
820gives xterm style selection. Only effective when the original (non-perl)
821selection code is in use.
822
823=item B<scrollstyle:> I<mode>
824
825Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
826the author's favourite.
827
828=item B<title:> I<string> 782=item B<title:> I<string>
829 783
830Set window title string, the default title is the command-line 784Set window title string, the default title is the command-line
831specified after the B<-e> option, if any, otherwise the application 785specified after the B<-e> option, if any, otherwise the application
832name; option B<-title>. 786name; option B<-title>.
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>.
877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 838 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878 839
879This creates a new file in your home directory with the screen contents 840This creates a new file in your home directory with the screen contents
880every time you hit C<Print>. 841every time you hit C<Print>.
881 842
843=item B<scrollstyle:> I<mode>
844
845Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
846the author's favourite.
847
848=item B<thickness:> I<number>
849
850Set the scrollbar width in pixels.
851
882=item B<scrollBar:> I<boolean> 852=item B<scrollBar:> I<boolean>
883 853
884B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 854B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885disable the scrollbar; option B<+sb>. 855disable the scrollbar; option B<+sb>.
886 856
905B<False>: do not scroll to bottom when tty receives output; option 875B<False>: do not scroll to bottom when tty receives output; option
906B<+si>. 876B<+si>.
907 877
908=item B<scrollWithBuffer:> I<boolean> 878=item B<scrollWithBuffer:> I<boolean>
909 879
910B<True>: scroll with scrollback buffer when tty receives new lines (and 880B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
911B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 881try to show the same lines) and B<scrollTtyOutput> is False; option
912with 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>.
913 884
914=item B<scrollTtyKeypress:> I<boolean> 885=item B<scrollTtyKeypress:> I<boolean>
915 886
916B<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
917are those which are intercepted by rxvt-unicode for special handling and 888are those which are intercepted by rxvt-unicode for special handling and
918are 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
919bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
920 891
921=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
922 893
923Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
924resource is limited on most machines to 65535; option B<-sl>.
925 895
926=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
927 897
928Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
929option B<-b>. 899option B<-b>.
973=item B<cursorBlink:> I<boolean> 943=item B<cursorBlink:> I<boolean>
974 944
975B<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];
976option B<-bc>. 946option B<-bc>.
977 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
978=item B<pointerBlank:> I<boolean> 953=item B<pointerBlank:> I<boolean>
979 954
980B<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
981of seconds of inactivity. B<False>: the pointer is always visible 956of seconds of inactivity. B<False>: the pointer is always visible
982[default]. 957[default].
987 962
988=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
989 964
990Mouse pointer background colour. 965Mouse pointer background colour.
991 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
992=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
993 974
994Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
995large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
996 977
997=item B<backspacekey:> I<string> 978=item B<backspacekey:> I<string>
998 979
999The 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>
1000or 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>
1001(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
1002escape sequence. 983escape sequence.
1003 984
1004=item B<deletekey:> I<string> 985=item B<deletekey:> I<string>
1005 986
1022 1003
1023B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1024 1005
1025=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
1026 1007
1027B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1028 1009
1029=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
1030 1011
1031I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
1032 1013
1049=item B<tripleclickwords:> I<boolean> 1030=item B<tripleclickwords:> I<boolean>
1050 1031
1051Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1052button. 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
1053the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevents emission of paste bracket sequences; option B<-dpb>.
1054 1039
1055=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1056 1041
1057Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
1058echo 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
1080 1065
1081=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1082 1067
1083Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1084 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
1085=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1086 1076
1087Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1088option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1089scrollback buffer and switching to/from the secondary screen will 1079scrollback buffer and, when secondaryScreen is off, switching
1090instead scroll the screen up. 1080to/from the secondary screen will instead scroll the screen up.
1091 1081
1092=item B<hold>: I<boolean> 1082=item B<hold>: I<boolean>
1093 1083
1094Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1084Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095will not immediately destroy its window when the program executed within 1085will not immediately destroy its window when the program executed within
1096it 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
1097user. 1087user.
1098 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
1099=item B<keysym.>I<sym>: I<string> 1096=item B<keysym.>I<sym>: I<action>
1100 1097
1101Compile I<frills>: Associate I<string> with keysym I<sym>. The 1098Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1102intervening resource name B<keysym.> cannot be omitted. 1099resource name B<keysym.> cannot be omitted.
1103 1100
1104The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1101Using this resource, you can map key combinations such as
1105any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1102C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1106B<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
1107and 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
1108B<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
1109 1130
1110The 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
1111whatever 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
1112keys 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
1113current application keymap mode state. 1134current application keymap mode state.
1114 1135
1115The 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
1116searching 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
1117omitting 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
1118keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1148value (B<0x0000 - 0xFFFF>).
1119performed in an exact manner; however, the closest match is assured.
1120 1149
1121I<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
1122number), see RESOURCES in C<man 7 X> for futher details. 1152number), see RESOURCES in C<man 7 X> for further details.
1123 1153
1124You 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
1125with 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 4
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
1126should be a character not used by the strings. 1178the delimiter `/' should be a character not used by the strings.
1127 1179
1128Its usage can be demonstrated by an example: 1180Its usage can be demonstrated by an example:
1129 1181
1130 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1131 1183
1132The above line is equivalent to the following three lines: 1184The above line is equivalent to the following three lines:
1133 1185
1134 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1135 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1136 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1137 1189
1190=item command:STRING
1191
1138If 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>
1139is 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
1140example 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>
1141when Control-Meta-c is being pressed": 1199when Control-Meta-c is being pressed":
1142 1200
1143 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
1144 1202
1145If 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
1146is 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
1147manpage. For example, the F<selection> extension (activated via 1205font-switching at runtime:
1148C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1149 1206
1150 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
1151 1209
1152Due the the large number of modifier combinations, a defined key mapping 1210Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1153will match if at I<at least> the specified identifiers are being set, and 1211info):
1154no other key mappings with those and more bits are being defined. That
1155means that defining a key map for C<a> will automatically provide
1156definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1157mappings themselves.
1158 1212
1159Unfortunately, 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
1160if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1223For example if you overwrite the C<Insert> key you will disable
1161C<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
1162user-defined keymap using the C<builtin:> replacement: 1225"holes" into the user-defined keymap using the C<builtin:> replacement:
1163 1226
1164 URxvt.keysym.Insert: <my insert key sequence> 1227 URxvt.keysym.Insert: <my insert key sequence>
1165 URxvt.keysym.S-Insert: builtin: 1228 URxvt.keysym.S-Insert: builtin:
1166 1229
1167The 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
1168of modifiers. The second line re-establishes the default mapping for 1231of modifiers. The second line re-establishes the default mapping for
1169C<Shift-Insert>. 1232C<Shift-Insert>.
1170 1233
1171The following example will map Control-Meta-1 and Control-Meta-2 to 1234=item builtin-string:
1172the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1173font-switching at runtime:
1174 1235
1175 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1236This action is mainly useful to restore string mappings for keys that
1176 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.
1177 1241
1178Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1242An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1179info): 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:
1180 1246
1181 URxvt.keysym.M-C-3: command:\033[8;25;80t 1247 URxvt.keysym.S-Insert: builtin-string:
1182 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
1183 1284
1184=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1185 1286
1186=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1187 1288
1189use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1190 1291
1191Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to prohibit using
1192them. This can be useful to selectively disable some extensions loaded 1293them. This can be useful to selectively disable some extensions loaded
1193by default, or specified via the C<perl-ext-common> resource. For 1294by default, or specified via the C<perl-ext-common> resource. For
1194example, C<default,-selection> will use all the default extension except 1295example, C<default,-selection> will use all the default extensions except
1195C<selection>. 1296C<selection>.
1196 1297
1197Extension names can also be followed by an argument in angle brackets 1298The default set includes the C<selection>, C<option-popup>,
1198(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299C<selection-popup>, C<readline> and C<searchable-scrollback>
1199searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300extensions, and extensions which are mentioned in B<keysym> resources.
1200multiple times with different arguments will pass multiple arguments to 1301
1201the extension. 1302Any extension such that a corresponding resource is given on the
1303command line is automatically appended to B<perl-ext>.
1202 1304
1203Each extension is looked up in the library directories, loaded if 1305Each extension is looked up in the library directories, loaded if
1204necessary, and bound to the current terminal instance. 1306necessary, and bound to the current terminal instance. When the library
1307search path contains multiple extension files of the same name, then the
1308first one found will be used.
1205 1309
1206If both of these resources are the empty string, then the perl 1310If both of these resources are the empty string, then the perl interpreter
1207interpreter will not be initialized. The idea behind two options is that 1311will not be initialized. The rationale for having two options is that
1208B<perl-ext-common> will be used for extensions that should be available to 1312B<perl-ext-common> will be used for extensions that should be available to
1209all instances, while B<perl-ext> is used for specific instances. 1313all instances, while B<perl-ext> is used for specific instances.
1210 1314
1211=item B<perl-eval>: I<string> 1315=item B<perl-eval>: I<string>
1212 1316
1213Perl code to be evaluated when all extensions have been registered. See 1317Perl code to be evaluated when all extensions have been registered. See
1214the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1318the @@RXVT_NAME@@perl(3) manpage.
1215will be ignored when running setuid/setgid.
1216 1319
1217=item B<perl-lib>: I<path> 1320=item B<perl-lib>: I<path>
1218 1321
1219Colon-separated list of additional directories that hold extension 1322Colon-separated list of additional directories that hold extension
1220scripts. When looking for extensions specified by the C<perl> resource, 1323scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1221@@RXVT_NAME@@ will first look in these directories and then in 1324in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1222F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1325lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1223will be ignored when running setuid/setgid.
1224 1326
1225See the @@RXVT_NAME@@perl(3) manpage. 1327See the @@RXVT_NAME@@perl(3) manpage.
1226 1328
1227=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1329=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1228 1330
1232=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1334=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1233 1335
1234Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1336Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1235for details. 1337for details.
1236 1338
1237=item B<searchable-scrollback:> I<keysym> 1339=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1238 1340
1239Sets the hotkey that starts the incremental scrollback buffer search 1341This resource is deprecated and will be removed. Use a B<keysym> resource
1240(default: C<M-s>). 1342instead, e.g.:
1241 1343
1344 URxvt.keysym.M-s: searchable-scrollback:start
1345
1242=item B<urlLauncher>: I<string> 1346=item B<url-launcher>: I<string>
1243 1347
1244Specifies the program to be started with a URL argument. Used by the 1348Specifies the program to be started with a URL argument. Used by the
1245C<selection-popup> and C<matcher> perl extensions. 1349C<selection-popup> and C<matcher> perl extensions.
1246 1350
1247=item B<transient-for>: I<windowid> 1351=item B<transient-for>: I<windowid>
1250 1354
1251=item B<override-redirect>: I<boolean> 1355=item B<override-redirect>: I<boolean>
1252 1356
1253Compile I<frills>: Sets override-redirect for the terminal window, making 1357Compile I<frills>: Sets override-redirect for the terminal window, making
1254it almost invisible to window managers; option B<-override-redirect>. 1358it almost invisible to window managers; option B<-override-redirect>.
1359
1360=item B<iso14755:> I<boolean>
1361
1362Turn on/off ISO 14755 (default enabled).
1255 1363
1256=item B<iso14755_52:> I<boolean> 1364=item B<iso14755_52:> I<boolean>
1257 1365
1258Turn on/off ISO 14755 5.2 mode (default enabled). 1366Turn on/off ISO 14755 5.2 mode (default enabled).
1259 1367
1311window causes the value of the PRIMARY selection (or CLIPBOARD with the 1419window causes the value of the PRIMARY selection (or CLIPBOARD with the
1312B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1420B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1313 1421
1314Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1422Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1315inserted too. 1423inserted too.
1424
1425rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1426<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1427binding causes the value of the internal selection to be copied to the
1428CLIPBOARD selection, while the second binding causes the value of the
1429CLIPBOARD selection to be inserted.
1316 1430
1317=back 1431=back
1318 1432
1319=head1 CHANGING FONTS 1433=head1 CHANGING FONTS
1320 1434
1402B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1516B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1403it can be seen via the I<who(1)> command, and can accept messages. To 1517it can be seen via the I<who(1)> command, and can accept messages. To
1404allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1518allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1405on some systems or setgid to root or to some other group on others. 1519on some systems or setgid to root or to some other group on others.
1406 1520
1407=head1 COLORS AND GRAPHICS 1521=head1 COLOURS AND GRAPHICS
1408 1522
1409In addition to the default foreground and background colours, 1523In addition to the default foreground and background colours,
1410B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1524B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1411high-intensity bold/blink versions of the same). Here is a list of the 1525high-intensity (potentially bold/blink) versions of the same, and 72 (or
1412colours with their names. 1526240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1527cube plus a 8 (24) colour greyscale ramp.
1528
1529B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1530C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1531number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1532colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
153324-bit colour space. When indexing collisions happen, the nearest old colour in
1534the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1535use many similar 24-bit colours. It's typically not a problem in common
1536scenarios.
1537
1538Here is a list of the ANSI colours with their names.
1413 1539
1414=begin table 1540=begin table
1415 1541
1416 B<color0> (black) = Black 1542 B<color0> (black) = Black
1417 B<color1> (red) = Red3 1543 B<color1> (red) = Red3
1437It is also possible to specify the colour values of B<foreground>, 1563It is also possible to specify the colour values of B<foreground>,
1438B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1564B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1439a number 0-15, as a convenient shorthand to reference the colour name of 1565a number 0-15, as a convenient shorthand to reference the colour name of
1440color0-color15. 1566color0-color15.
1441 1567
1442In addition to the colours defined above, @@RXVT_NAME@@ offers an 1568The following text gives values for the standard 88 colour mode (and
1443additional 72 colours. The first 64 of those (with indices 16 to 79) 1569values for the 256 colour mode in parentheses).
1444consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144516>), followed by 8 additional shades of gray (with indices 80 to 87).
1446 1570
1571The RGB cube uses indices 16..79 (16..231) using the following formulas:
1572
1573 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1574 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1575
1576The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1577steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1578the RGB cube.
1579
1447Together, all those colours implement the 88 colour xterm colours. Only 1580Together, all those colours implement the 88 (256) colour xterm
1448the first 16 can be changed using resources currently, the rest can only 1581colours. Only the first 16 can be changed using resources currently, the
1449be changed via command sequences ("escape codes"). 1582rest can only be changed via command sequences ("escape codes").
1583
1584Applications are advised to use terminfo or command sequences to discover
1585number and RGB values of all colours (yes, you can query this...).
1450 1586
1451Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1587Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1452always swapping the foreground/background colours. This is in contrast to 1588always swapping the foreground/background colours. This is in contrast to
1453I<xterm>(1) where the colours are only swapped if they have not otherwise 1589I<xterm>(1) where the colours are only swapped if they have not otherwise
1454been specified. For example, 1590been specified. For example,
1455 1591
1456=over 4
1457
1458=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1592 @@RXVT_NAME@@ -fg Black -bg White -rv
1459 1593
1460would yield White on Black, while on I<xterm>(1) it would yield Black 1594would yield White on Black, while on I<xterm>(1) it would yield Black on
1461on White. 1595White.
1462
1463=back
1464 1596
1465=head2 ALPHA CHANNEL SUPPORT 1597=head2 ALPHA CHANNEL SUPPORT
1466 1598
1467If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1599If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1468their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1600their act together, rxvt-unicode will do its own alpha channel management:
1469(recommended, but B<MUST> have 4 digits/component) colour specifications, 1601
1470in addition to the ones provided by X, where the additional A component 1602You can prefix any colour with an opaqueness percentage enclosed in
1603brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1604(0-100) that specifies the opacity of the colour, where C<0> is completely
1605transparent and C<100> is completely opaque. For example, C<[50]red> is a
1606half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1607is the recommended format to specify transparency values, and works with
1608all ways to specify a colour.
1609
1610For complete control, rxvt-unicode also supports
1611C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1612specifications, where the additional C<aaaa> component specifies opacity
1471specifies opacity (alpha) values. The minimum value of C<0> is completely 1613(alpha) values. The minimum value of C<0000> is completely transparent,
1472transparent). You can also prefix any color with C<[percent]>, where 1614while C<ffff> is completely opaque). The two example colours from
1473C<percent> is a decimal percentage (0-100) that specifies the opacity of 1615earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1474the color, where C<0> is completely transparent and C<100> is completelxy 1616C<rgba:0000/ff00/0000/f332>.
1475opaque.
1476 1617
1477You probably need to specify B<"-depth 32">, too, and have the luck that 1618You probably need to specify B<"-depth 32">, too, to force a visual with
1478your X-server uses ARGB pixel layout, as X is far from just supporting 1619alpha channels, and have the luck that your X-server uses ARGB pixel
1479ARGB visuals out of the box, and rxvt-unicode just fudges around. 1620layout, as X is far from just supporting ARGB visuals out of the box, and
1621rxvt-unicode just fudges around.
1480 1622
1481For example, the following selects an almost completely transparent red 1623For example, the following selects an almost completely transparent black
1482background, and an almost opaque pink foreground: 1624background, and an almost opaque pink foreground:
1483 1625
1484 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1626 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485 1627
1486I<Please note that transparency of any kind if completely unsupported by 1628When not using a background image, then the interpretation of the
1487the author. Don't bug him with installation questions!> 1629alpha channel is up to your compositing manager (most interpret it as
1630transparency of course).
1631
1632When using a background pixmap or pseudo-transparency, then the background
1633colour will always behave as if it were completely transparent (so the
1634background image shows instead), regardless of how it was specified, while
1635other colours will either be transparent as specified (the background
1636image will show through) on servers supporting the RENDER extension, or
1637fully opaque on servers not supporting the RENDER EXTENSION.
1638
1639Please note that due to bugs in Xft, specifying alpha values might result
1640in garbage being displayed when the X-server does not support the RENDER
1641extension.
1488 1642
1489=head1 ENVIRONMENT 1643=head1 ENVIRONMENT
1490 1644
1491B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1645B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492 1646
1526C<--with-terminfo=PATH>. 1680C<--with-terminfo=PATH>.
1527 1681
1528=item B<DISPLAY> 1682=item B<DISPLAY>
1529 1683
1530Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1684Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1531display in its child processes. 1685display in its child processes if C<-display> isn't used to override. It
1686defaults to C<:0> if it doesn't exist.
1532 1687
1533=item B<SHELL> 1688=item B<SHELL>
1534 1689
1535The shell to be used for command execution, defaults to C</bin/sh>. 1690The shell to be used for command execution, defaults to C</bin/sh>.
1536 1691
1537=item B<RXVT_SOCKET> 1692=item B<RXVT_SOCKET> [I<sic>]
1538 1693
1539The unix domain socket path used by @@RXVT_NAME@@c(1) and 1694The unix domain socket path used by @@RXVT_NAME@@c(1) and
1540@@RXVT_NAME@@d(1). 1695@@RXVT_NAME@@d(1).
1541 1696
1542Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1697Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1698
1699=item B<URXVT_PERL_LIB>
1700
1701Additional F<:>-separated library search path for perl extensions. Will be
1702searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1703directory.
1704
1705=item B<URXVT_PERL_VERBOSITY>
1706
1707See L<@@RXVT_NAME@@perl>(3).
1543 1708
1544=item B<HOME> 1709=item B<HOME>
1545 1710
1546Used to locate the default directory for the unix domain socket for 1711Used to locate the default directory for the unix domain socket for
1547daemon communications and to locate various resource files (such as 1712daemon communications and to locate various resource files (such as
1548C<.Xdefaults>) 1713C<.Xdefaults>)
1549 1714
1550=item B<XAPPLRESDIR> 1715=item B<XAPPLRESDIR>
1551 1716
1552Directory where various X resource files are being located. 1717Directory where application-specific X resource files are located.
1553 1718
1554=item B<XENVIRONMENT> 1719=item B<XENVIRONMENT>
1555 1720
1556If set and accessible, gives the name of a X resource file to be loaded by 1721If set and accessible, gives the name of a X resource file to be loaded by
1557@@RXVT_NAME@@. 1722@@RXVT_NAME@@.
1562 1727
1563=over 4 1728=over 4
1564 1729
1565=item B</usr/lib/X11/rgb.txt> 1730=item B</usr/lib/X11/rgb.txt>
1566 1731
1567Color names. 1732Colour names.
1568 1733
1569=back 1734=back
1570 1735
1571=head1 SEE ALSO 1736=head1 SEE ALSO
1572 1737
1738@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1573@@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) 1739@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1574 1740
1575=head1 CURRENT PROJECT COORDINATOR 1741=head1 CURRENT PROJECT COORDINATOR
1576 1742
1577=over 4 1743=over 4
1578 1744
1579=item Project Coordinator 1745=item Project Coordinator
1580 1746
1581Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1747Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1582 1748
1583L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1749L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1584 1750
1585=back 1751=back
1586 1752
1590 1756
1591=item John Bovey 1757=item John Bovey
1592 1758
1593University of Kent, 1992, wrote the original Xvt. 1759University of Kent, 1992, wrote the original Xvt.
1594 1760
1595=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1761=item Rob Nation <nation@rocket.sanders.lockheed.com>
1596 1762
1597very heavily modified Xvt and came up with Rxvt 1763very heavily modified Xvt and came up with Rxvt
1598 1764
1599=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1765=item Angelo Haritsis <ah@doc.ic.ac.uk>
1600 1766
1601wrote the Greek Keyboard Input (no longer in code) 1767wrote the Greek Keyboard Input (no longer in code)
1602 1768
1603=item mj olesen L<< <olesen@me.QueensU.CA> >> 1769=item mj olesen <olesen@me.QueensU.CA>
1604 1770
1605Wrote the menu system. 1771Wrote the menu system.
1606 1772
1607Project Coordinator (changes.txt 2.11 to 2.21) 1773Project Coordinator (changes.txt 2.11 to 2.21)
1608 1774
1609=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1775=item Oezguer Kesim <kesim@math.fu-berlin.de>
1610 1776
1611Project Coordinator (changes.txt 2.21a to 2.4.5) 1777Project Coordinator (changes.txt 2.21a to 2.4.5)
1612 1778
1613=item Geoff Wing L<< <gcw@pobox.com> >> 1779=item Geoff Wing <gcw@pobox.com>
1614 1780
1615Rewrote screen display and text selection routines. 1781Rewrote screen display and text selection routines.
1616 1782
1617Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1783Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1618 1784
1619=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1620 1786
1621Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1787Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1622extension, random hacks, numerous bugfixes and extensions. 1788extension, random hacks, numerous bugfixes and extensions.
1623 1789
1624Project Coordinator (Changes 1.0 -) 1790Project Coordinator (Changes 1.0 -)
1625 1791
1626=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1792=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1627 1793
1628Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1794pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1629 1795
1630=back 1796=back
1631 1797

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines