… | |
… | |
98 | is still respected. but deprecated). In the absence of this option, the |
98 | is still respected. but deprecated). In the absence of this option, the |
99 | display specified by the B<DISPLAY> environment variable is used. |
99 | display 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 | |
103 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
103 | Compile I<frills>: Attempt to find a visual with the given bit depth; |
104 | resource B<depth>. |
104 | resource 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 |
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
108 | of graphical corruption. This is harmless, but we can't do anything about |
108 | of graphical corruption. This is harmless, but we can't do anything about |
109 | this, so watch out] |
109 | this, so watch out] |
110 | |
110 | |
|
|
111 | =item B<-visual> I<visualID> |
|
|
112 | |
|
|
113 | Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for |
|
|
114 | possible visual ids) instead of the default, and also allocate a private |
|
|
115 | colormap. All visual types except for DirectColor are supported. |
|
|
116 | |
111 | =item B<-geometry> I<geom> |
117 | =item B<-geometry> I<geom> |
112 | |
118 | |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
119 | Window geometry (B<-g> still respected); resource B<geometry>. |
114 | |
120 | |
115 | =item B<-rv>|B<+rv> |
121 | =item B<-rv>|B<+rv> |
… | |
… | |
121 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
127 | Turn 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 | |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
131 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
126 | |
|
|
127 | =item B<-tr>|B<+tr> |
|
|
128 | |
|
|
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
|
|
130 | |
|
|
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
|
|
132 | future versions. |
|
|
133 | |
|
|
134 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
135 | sasha@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 | |
139 | Fade the text by the given percentage when focus is lost. Small values |
135 | Fade the text by the given percentage when focus is lost. Small values |
140 | fade a little only, 100 completely replaces all colours by the fade |
136 | fade 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 | |
145 | Fade to this colour when fading is used (see B<-fade>). The default colour |
141 | Fade to this colour when fading is used (see B<-fade>). The default colour |
146 | is opaque black. resource B<fadeColor>. |
142 | is opaque black. resource B<fadeColor>. |
147 | |
143 | |
148 | =item B<-tint> I<colour> |
|
|
149 | |
|
|
150 | Tint the transparent background pixmap with the given colour when |
|
|
151 | transparency is enabled with B<-tr>. This only works for |
|
|
152 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
|
|
153 | used to brighten or darken the image in addition to tinting it. |
|
|
154 | Please note that certain tint colours can be applied on the server-side, |
|
|
155 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
156 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
157 | pure black and pure white colors essentially mean no tinting; resource |
|
|
158 | I<tintColor>. Example: |
|
|
159 | |
|
|
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
|
|
161 | |
|
|
162 | =item B<-sh> I<number> |
|
|
163 | |
|
|
164 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
|
|
165 | background image in addition to (or instead of) tinting it; |
|
|
166 | resource I<shading>. |
|
|
167 | |
|
|
168 | =item B<-blt> I<string> |
|
|
169 | |
|
|
170 | Specify background blending type. If background pixmap is specified |
|
|
171 | at the same time as transparency - such pixmap will be blended over |
|
|
172 | transparency image, using method specified. Supported values are : |
|
|
173 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
174 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
175 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
176 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
|
|
177 | |
|
|
178 | =item B<-blr> I<HxV> |
|
|
179 | |
|
|
180 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
181 | background image. If single number is specified - both vertical and |
|
|
182 | horizontal radii are considered to be the same. Setting one of the |
|
|
183 | radii to 1 and another to a large number creates interesting effects |
|
|
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
|
|
185 | resource I<blurRadius>. |
|
|
186 | |
|
|
187 | =item B<-icon> I<file> |
144 | =item B<-icon> I<file> |
188 | |
145 | |
189 | Compile I<afterimage>: Use the specified image as application icon. This |
146 | Compile I<pixbuf>: Use the specified image as application icon. This |
190 | is used by many window managers, taskbars and pagers to represent the |
147 | is used by many window managers, taskbars and pagers to represent the |
191 | appliation window; resource I<iconFile>. |
148 | application window; resource I<iconFile>. |
192 | |
149 | |
193 | =item B<-bg> I<colour> |
150 | =item B<-bg> I<colour> |
194 | |
151 | |
195 | Window background colour; resource B<background>. |
152 | Window background colour; resource B<background>. |
196 | |
153 | |
197 | =item B<-fg> I<colour> |
154 | =item B<-fg> I<colour> |
198 | |
155 | |
199 | Window foreground colour; resource B<foreground>. |
156 | Window foreground colour; resource B<foreground>. |
200 | |
|
|
201 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
|
|
202 | |
|
|
203 | Compile I<afterimage>: Specify image file for the background and also |
|
|
204 | optionally specify its scaling with a geometry string. Note you may need to |
|
|
205 | add quotes to avoid special shell interpretation of the C<;> in the |
|
|
206 | command-line; for more details see resource B<backgroundPixmap>. |
|
|
207 | |
157 | |
208 | =item B<-cr> I<colour> |
158 | =item B<-cr> I<colour> |
209 | |
159 | |
210 | The cursor colour; resource B<cursorColor>. |
160 | The cursor colour; resource B<cursorColor>. |
211 | |
161 | |
… | |
… | |
270 | |
220 | |
271 | =item B<-ls>|B<+ls> |
221 | =item B<-ls>|B<+ls> |
272 | |
222 | |
273 | Start as a login-shell/sub-shell; resource B<loginShell>. |
223 | Start as a login-shell/sub-shell; resource B<loginShell>. |
274 | |
224 | |
|
|
225 | =item B<-mc> I<milliseconds> |
|
|
226 | |
|
|
227 | Specify the maximum time between multi-click selections. |
|
|
228 | |
275 | =item B<-ut>|B<+ut> |
229 | =item B<-ut>|B<+ut> |
276 | |
230 | |
277 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
231 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
278 | B<utmpInhibit>. |
232 | B<utmpInhibit>. |
279 | |
233 | |
… | |
… | |
321 | |
275 | |
322 | =item B<-bc>|B<+bc> |
276 | =item B<-bc>|B<+bc> |
323 | |
277 | |
324 | Blink the cursor; resource B<cursorBlink>. |
278 | Blink the cursor; resource B<cursorBlink>. |
325 | |
279 | |
|
|
280 | =item B<-uc>|B<+uc> |
|
|
281 | |
|
|
282 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
283 | |
326 | =item B<-iconic> |
284 | =item B<-iconic> |
327 | |
285 | |
328 | Start iconified, if the window manager supports that option. |
286 | Start iconified, if the window manager supports that option. |
329 | Alternative form is B<-ic>. |
287 | Alternative form is B<-ic>. |
330 | |
288 | |
… | |
… | |
354 | =item B<-override-redirect> |
312 | =item B<-override-redirect> |
355 | |
313 | |
356 | Compile I<frills>: Sets override-redirect on the window; resource |
314 | Compile I<frills>: Sets override-redirect on the window; resource |
357 | B<override-redirect>. |
315 | B<override-redirect>. |
358 | |
316 | |
|
|
317 | =item B<-dockapp> |
|
|
318 | |
|
|
319 | Sets the initial state of the window to WithdrawnState, which makes |
|
|
320 | window managers that support this extension treat it as a dockapp. |
|
|
321 | |
359 | =item B<-sbg> |
322 | =item B<-sbg> |
360 | |
323 | |
361 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
324 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
362 | drawing characters and just rely on what the specified fonts provide. Use |
325 | drawing characters and just rely on what the specified fonts provide. Use |
363 | this if you have a good font and want to use its block graphic glyphs; |
326 | this if you have a good font and want to use its block graphic glyphs; |
… | |
… | |
366 | =item B<-lsp> I<number> |
329 | =item B<-lsp> I<number> |
367 | |
330 | |
368 | Compile I<frills>: Lines (pixel height) to insert between each row of |
331 | Compile I<frills>: Lines (pixel height) to insert between each row of |
369 | the display. Useful to work around font rendering problems; resource |
332 | the display. Useful to work around font rendering problems; resource |
370 | B<lineSpace>. |
333 | B<lineSpace>. |
|
|
334 | |
|
|
335 | =item B<-letsp> I<number> |
|
|
336 | |
|
|
337 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
338 | to control overall letter spacing. Negative values will tighten up the |
|
|
339 | letter spacing, positive values will space letters out more. Useful to |
|
|
340 | work around odd font metrics; resource B<letterSpace>. |
371 | |
341 | |
372 | =item B<-tn> I<termname> |
342 | =item B<-tn> I<termname> |
373 | |
343 | |
374 | This option specifies the name of the terminal type to be set in the |
344 | This option specifies the name of the terminal type to be set in the |
375 | B<TERM> environment variable. This terminal type must exist in the |
345 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
410 | =item B<-pt> I<style> |
380 | =item B<-pt> I<style> |
411 | |
381 | |
412 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
382 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
413 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
383 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
414 | |
384 | |
|
|
385 | If the perl extension C<xim-onthespot> is used (which is the default), |
|
|
386 | then additionally the C<OnTheSpot> preedit type is available. |
|
|
387 | |
415 | =item B<-im> I<text> |
388 | =item B<-im> I<text> |
416 | |
389 | |
417 | Compile I<XIM>: input method name. resource B<inputMethod>. |
390 | Compile I<XIM>: input method name. resource B<inputMethod>. |
418 | |
391 | |
419 | =item B<-imlocale> I<string> |
392 | =item B<-imlocale> I<string> |
… | |
… | |
560 | You can set and change the resources using X11 tools like B<xrdb>. Many |
533 | You can set and change the resources using X11 tools like B<xrdb>. Many |
561 | distribution do also load settings from the B<~/.Xresources> file when X |
534 | distribution do also load settings from the B<~/.Xresources> file when X |
562 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
535 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
563 | with later settings overwriting earlier ones: |
536 | with later settings overwriting earlier ones: |
564 | |
537 | |
565 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
566 | 2. app-defaults file in $XAPPLRESDIR |
538 | 1. app-defaults file in $XAPPLRESDIR |
|
|
539 | 2. $HOME/.Xdefaults |
567 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
540 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
568 | 4. SCREEN_RESOURCES for the current screen |
541 | 4. SCREEN_RESOURCES property on root-window of the current screen |
569 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
542 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
570 | 6. resources specified via -xrm on the commandline |
543 | 6. resources specified via -xrm on the commandline |
571 | |
544 | |
572 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
545 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
573 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
546 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
… | |
… | |
614 | Use the specified colour for the colour value I<n>, where 0-7 |
587 | Use the specified colour for the colour value I<n>, where 0-7 |
615 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
588 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
616 | high-intensity (bold = bright foreground, blink = bright background) |
589 | high-intensity (bold = bright foreground, blink = bright background) |
617 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
590 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
618 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
591 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
619 | names used are listed in the B<COLORS AND GRAPHICS> section. |
592 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
620 | |
593 | |
621 | Colours higher than 15 cannot be set using resources (yet), but can be |
594 | Colours higher than 15 cannot be set using resources (yet), but can be |
622 | changed using an escape command (see @@RXVT_NAME@@(7)). |
595 | changed using an escape command (see @@RXVT_NAME@@(7)). |
623 | |
596 | |
624 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
597 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
635 | =item B<colorUL:> I<colour> |
608 | =item B<colorUL:> I<colour> |
636 | |
609 | |
637 | Use the specified colour to display underlined characters when the |
610 | Use the specified colour to display underlined characters when the |
638 | foreground colour is the default. |
611 | foreground colour is the default. |
639 | |
612 | |
640 | =item B<colorRV:> I<colour> |
|
|
641 | |
|
|
642 | Use the specified colour as the background for reverse video characters |
|
|
643 | when OPTION_HC is disabled (--disable-frills). |
|
|
644 | |
|
|
645 | =item B<underlineColor:> I<colour> |
613 | =item B<underlineColor:> I<colour> |
646 | |
614 | |
647 | If set, use the specified colour as the colour for the underline |
615 | If set, use the specified colour as the colour for the underline |
648 | itself. If unset, use the foreground colour. |
616 | itself. If unset, use the foreground colour. |
|
|
617 | |
|
|
618 | =item B<highlightColor:> I<colour> |
|
|
619 | |
|
|
620 | If set, use the specified colour as the background for highlighted |
|
|
621 | characters. If unset, use reverse video. |
|
|
622 | |
|
|
623 | =item B<highlightTextColor:> I<colour> |
|
|
624 | |
|
|
625 | If set and highlightColor is set, use the specified colour as the |
|
|
626 | foreground for highlighted characters. |
649 | |
627 | |
650 | =item B<cursorColor:> I<colour> |
628 | =item B<cursorColor:> I<colour> |
651 | |
629 | |
652 | Use the specified colour for the cursor. The default is to use the |
630 | Use the specified colour for the cursor. The default is to use the |
653 | foreground colour; option B<-cr>. |
631 | foreground colour; option B<-cr>. |
… | |
… | |
660 | |
638 | |
661 | =item B<reverseVideo:> I<boolean> |
639 | =item B<reverseVideo:> I<boolean> |
662 | |
640 | |
663 | B<True>: simulate reverse video by foreground and background colours; |
641 | B<True>: simulate reverse video by foreground and background colours; |
664 | option B<-rv>. B<False>: regular screen colours [default]; option |
642 | option B<-rv>. B<False>: regular screen colours [default]; option |
665 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
643 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
666 | |
644 | |
667 | =item B<jumpScroll:> I<boolean> |
645 | =item B<jumpScroll:> I<boolean> |
668 | |
646 | |
669 | B<True>: specify that jump scrolling should be used. When receiving lots |
647 | B<True>: specify that jump scrolling should be used. When receiving lots |
670 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
648 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
… | |
… | |
684 | |
662 | |
685 | B<False>: specify that everything is to be displayed, even |
663 | B<False>: specify that everything is to be displayed, even |
686 | if the refresh is too fast for the human eye to read anything (or the |
664 | if the refresh is too fast for the human eye to read anything (or the |
687 | monitor to display anything); option B<+ss>. |
665 | monitor to display anything); option B<+ss>. |
688 | |
666 | |
689 | =item B<transparent:> I<boolean> |
|
|
690 | |
|
|
691 | Turn on/off illusion of a transparent window background. |
|
|
692 | |
|
|
693 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
694 | future versions. |
|
|
695 | |
|
|
696 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
697 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
698 | |
|
|
699 | =item B<fading:> I<number> |
667 | =item B<fading:> I<number> |
700 | |
668 | |
701 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
669 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
702 | |
670 | |
703 | =item B<fadeColor:> I<colour> |
671 | =item B<fadeColor:> I<colour> |
704 | |
672 | |
705 | Fade to this colour, when fading is used (see B<fading:>). The default |
673 | Fade to this colour, when fading is used (see B<fading:>). The default |
706 | colour is black; option B<-fadecolor>. |
674 | colour is black; option B<-fadecolor>. |
707 | |
675 | |
708 | =item B<tintColor:> I<colour> |
|
|
709 | |
|
|
710 | Tint the transparent background pixmap with the given colour; option |
|
|
711 | B<-tint>. |
|
|
712 | |
|
|
713 | =item B<shading:> I<number> |
|
|
714 | |
|
|
715 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
|
|
716 | in addition to tinting it; option B<-sh>. |
|
|
717 | |
|
|
718 | =item B<blendType:> I<string> |
|
|
719 | |
|
|
720 | Specify background blending type; option B<-blt>. |
|
|
721 | |
|
|
722 | =item B<blurRadius:> I<number> |
|
|
723 | |
|
|
724 | Apply gaussian blur with the specified radius to the transparent |
|
|
725 | background image; option B<-blr>. |
|
|
726 | |
|
|
727 | =item B<iconFile:> I<file> |
676 | =item B<iconFile:> I<file> |
728 | |
677 | |
729 | Set the application icon pixmap; option B<-icon>. |
678 | Set the application icon pixmap; option B<-icon>. |
730 | |
679 | |
731 | =item B<scrollColor:> I<colour> |
680 | =item B<scrollColor:> I<colour> |
… | |
… | |
739 | |
688 | |
740 | =item B<borderColor:> I<colour> |
689 | =item B<borderColor:> I<colour> |
741 | |
690 | |
742 | The colour of the border around the text area and between the scrollbar |
691 | The colour of the border around the text area and between the scrollbar |
743 | and the text. |
692 | and the text. |
744 | |
|
|
745 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
|
|
746 | |
|
|
747 | Use the specified image file for the background and also |
|
|
748 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
|
|
749 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
|
|
750 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
|
|
751 | centre (percent). A scale of 0 displays the image with tiling. A scale |
|
|
752 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
|
|
753 | an integer number of images in that direction. No image will be magnified |
|
|
754 | beyond 10 times its original size. The maximum permitted scale is 1000. |
|
|
755 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
756 | Supported operations are: |
|
|
757 | |
|
|
758 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
759 | propscale will scale image keeping proportions |
|
|
760 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
761 | hscale will scale image horizontally to the window size |
|
|
762 | vscale will scale image vertically to the window size |
|
|
763 | scale will scale image to match window size |
|
|
764 | root will tile image as if it was a root window background, auto-adjusting |
|
|
765 | whenever terminal window moves |
|
|
766 | |
|
|
767 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
768 | blended over transparency image using either alpha-blending, or any |
|
|
769 | other blending type, specified with B<-blt "type"> option. |
|
|
770 | |
|
|
771 | =item B<path:> I<path> |
|
|
772 | |
|
|
773 | Specify the colon-delimited search path for finding background image files. |
|
|
774 | |
693 | |
775 | =item B<font:> I<fontlist> |
694 | =item B<font:> I<fontlist> |
776 | |
695 | |
777 | Select the fonts to be used. This is a comma separated list of font names |
696 | Select the fonts to be used. This is a comma separated list of font names |
778 | that are checked in order when trying to find glyphs for characters. The |
697 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
801 | it is named first) and thus defines the character cell grid to be 9 pixels |
720 | it is named first) and thus defines the character cell grid to be 9 pixels |
802 | wide and 15 pixels high. |
721 | wide and 15 pixels high. |
803 | |
722 | |
804 | The second font is just used to add additional unicode characters not in |
723 | The second font is just used to add additional unicode characters not in |
805 | the base font, likewise the third, which is unfortunately non-bold, but |
724 | the base font, likewise the third, which is unfortunately non-bold, but |
806 | the bold version of the font does contain less characters, so this is a |
725 | the bold version of the font does contain fewer characters, so this is a |
807 | useful supplement. |
726 | useful supplement. |
808 | |
727 | |
809 | The third font is an Xft font with aliasing turned off, and the characters |
728 | The third font is an Xft font with aliasing turned off, and the characters |
810 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
729 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
811 | contains other characters, but we are not interested in them. |
730 | contains other characters, but we are not interested in them. |
… | |
… | |
875 | |
794 | |
876 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
795 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
877 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
796 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
878 | [default]; option B<+ls>. |
797 | [default]; option B<+ls>. |
879 | |
798 | |
|
|
799 | =item B<multiClickTime:> I<number> |
|
|
800 | |
|
|
801 | Specify the maximum time in milliseconds between multi-click select |
|
|
802 | events. The default is 500 milliseconds; option B<-mc>. |
|
|
803 | |
880 | =item B<utmpInhibit:> I<boolean> |
804 | =item B<utmpInhibit:> I<boolean> |
881 | |
805 | |
882 | B<True>: inhibit writing record into the system log file B<utmp>; |
806 | B<True>: inhibit writing record into the system log file B<utmp>; |
883 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
807 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
884 | [default]; option B<+ut>. |
808 | [default]; option B<+ut>. |
… | |
… | |
901 | =item B<scrollstyle:> I<mode> |
825 | =item B<scrollstyle:> I<mode> |
902 | |
826 | |
903 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
827 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
904 | the author's favourite. |
828 | the author's favourite. |
905 | |
829 | |
|
|
830 | =item B<thickness:> I<number> |
|
|
831 | |
|
|
832 | Set the scrollbar width in pixels. |
|
|
833 | |
906 | =item B<scrollBar:> I<boolean> |
834 | =item B<scrollBar:> I<boolean> |
907 | |
835 | |
908 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
836 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
909 | disable the scrollbar; option B<+sb>. |
837 | disable the scrollbar; option B<+sb>. |
910 | |
838 | |
… | |
… | |
929 | B<False>: do not scroll to bottom when tty receives output; option |
857 | B<False>: do not scroll to bottom when tty receives output; option |
930 | B<+si>. |
858 | B<+si>. |
931 | |
859 | |
932 | =item B<scrollWithBuffer:> I<boolean> |
860 | =item B<scrollWithBuffer:> I<boolean> |
933 | |
861 | |
934 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
862 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
935 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
863 | try to show the same lines) and B<scrollTtyOutput> is False; option |
936 | with scrollback buffer when tty receives new lines; option B<+sw>. |
864 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
865 | new lines; option B<+sw>. |
937 | |
866 | |
938 | =item B<scrollTtyKeypress:> I<boolean> |
867 | =item B<scrollTtyKeypress:> I<boolean> |
939 | |
868 | |
940 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
869 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
941 | are those which are intercepted by rxvt-unicode for special handling and |
870 | are those which are intercepted by rxvt-unicode for special handling and |
942 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
871 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
943 | bottom when a non-special key is pressed; option B<+sk>. |
872 | bottom when a non-special key is pressed; option B<+sk>. |
944 | |
873 | |
945 | =item B<saveLines:> I<number> |
874 | =item B<saveLines:> I<number> |
946 | |
875 | |
947 | Save I<number> lines in the scrollback buffer [default 64]. This |
876 | Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>. |
948 | resource is limited on most machines to 65535; option B<-sl>. |
|
|
949 | |
877 | |
950 | =item B<internalBorder:> I<number> |
878 | =item B<internalBorder:> I<number> |
951 | |
879 | |
952 | Internal border of I<number> pixels. This resource is limited to 100; |
880 | Internal border of I<number> pixels. This resource is limited to 100; |
953 | option B<-b>. |
881 | option B<-b>. |
… | |
… | |
997 | =item B<cursorBlink:> I<boolean> |
925 | =item B<cursorBlink:> I<boolean> |
998 | |
926 | |
999 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
927 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1000 | option B<-bc>. |
928 | option B<-bc>. |
1001 | |
929 | |
|
|
930 | =item B<cursorUnderline:> I<boolean> |
|
|
931 | |
|
|
932 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
933 | option B<-uc>. |
|
|
934 | |
1002 | =item B<pointerBlank:> I<boolean> |
935 | =item B<pointerBlank:> I<boolean> |
1003 | |
936 | |
1004 | B<True>: blank the pointer when a key is pressed or after a set number |
937 | B<True>: blank the pointer when a key is pressed or after a set number |
1005 | of seconds of inactivity. B<False>: the pointer is always visible |
938 | of seconds of inactivity. B<False>: the pointer is always visible |
1006 | [default]. |
939 | [default]. |
… | |
… | |
1011 | |
944 | |
1012 | =item B<pointerColor2:> I<colour> |
945 | =item B<pointerColor2:> I<colour> |
1013 | |
946 | |
1014 | Mouse pointer background colour. |
947 | Mouse pointer background colour. |
1015 | |
948 | |
|
|
949 | =item B<pointerShape:> I<string> |
|
|
950 | |
|
|
951 | Compile I<frills>: Specifies the name of the mouse pointer shape |
|
|
952 | [default B<xterm>]. See the macros in the B<X11/cursorfont.h> include |
|
|
953 | file for possible values (omit the C<XC_> prefix). |
|
|
954 | |
1016 | =item B<pointerBlankDelay:> I<number> |
955 | =item B<pointerBlankDelay:> I<number> |
1017 | |
956 | |
1018 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
957 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
1019 | large number (e.g. C<987654321>) to effectively disable the timeout. |
958 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1020 | |
959 | |
1021 | =item B<backspacekey:> I<string> |
960 | =item B<backspacekey:> I<string> |
1022 | |
961 | |
1023 | The string to send when the backspace key is pressed. If set to B<DEC> |
962 | The string to send when the backspace key is pressed. If set to B<DEC> |
1024 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
963 | or unset it will send B<Delete> (code 127) or, with control, B<Backspace> |
1025 | (code 8) - which can be reversed with the appropriate DEC private mode |
964 | (code 8) - which can be reversed with the appropriate DEC private mode |
1026 | escape sequence. |
965 | escape sequence. |
1027 | |
966 | |
1028 | =item B<deletekey:> I<string> |
967 | =item B<deletekey:> I<string> |
1029 | |
968 | |
… | |
… | |
1046 | |
985 | |
1047 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
986 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
1048 | |
987 | |
1049 | =item B<preeditType:> I<style> |
988 | =item B<preeditType:> I<style> |
1050 | |
989 | |
1051 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
990 | B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1052 | |
991 | |
1053 | =item B<inputMethod:> I<name> |
992 | =item B<inputMethod:> I<name> |
1054 | |
993 | |
1055 | I<name> of inputMethod to use; option B<-im>. |
994 | I<name> of inputMethod to use; option B<-im>. |
1056 | |
995 | |
… | |
… | |
1125 | Sets the working directory for the shell (or the command specified via |
1064 | Sets the working directory for the shell (or the command specified via |
1126 | B<-e>). The I<path> must be an absolute path and it must exist for |
1065 | B<-e>). The I<path> must be an absolute path and it must exist for |
1127 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1066 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1128 | directory will be used; option B<-cd>. |
1067 | directory will be used; option B<-cd>. |
1129 | |
1068 | |
1130 | =item B<keysym.>I<sym>: I<string> |
1069 | =item B<keysym.>I<sym>: I<action> |
1131 | |
1070 | |
1132 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1071 | Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening |
1133 | intervening resource name B<keysym.> cannot be omitted. |
1072 | resource name B<keysym.> cannot be omitted. |
1134 | |
1073 | |
1135 | The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be |
1074 | Using this resource, you can map key combinations such as |
1136 | any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
1075 | C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different |
1137 | B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, |
1076 | string than would normally result from that combination, making the |
1138 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
1077 | terminal scroll up or down the way you want it, or any other thing an |
1139 | B<2>, B<3>, B<4>, B<5>. |
1078 | extension might provide. |
|
|
1079 | |
|
|
1080 | The key combination that triggers the action, I<sym>, has the following format: |
|
|
1081 | |
|
|
1082 | (modifiers-)key |
|
|
1083 | |
|
|
1084 | Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, |
|
|
1085 | B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, |
|
|
1086 | B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, |
|
|
1087 | B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. |
1140 | |
1088 | |
1141 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1089 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1142 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1090 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1143 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1091 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1144 | current application keymap mode state. |
1092 | current application keymap mode state. |
1145 | |
1093 | |
1146 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
1094 | Due the the large number of modifier combinations, a key mapping will |
1147 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1095 | match if I<at least> the specified identifiers are being set, and no other |
|
|
1096 | key mappings with those and more bits are being defined. That means that |
|
|
1097 | defining a mapping for C<a> will automatically provide definitions for |
|
|
1098 | C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings |
|
|
1099 | themselves. See the C<builtin:> action, below, for a way to work around |
|
|
1100 | this when this is a problem. |
|
|
1101 | |
|
|
1102 | The spelling of I<key> depends on your implementation of X. An easy way to |
|
|
1103 | find a key name is to use the B<xev>(1) command. You can find a list by |
|
|
1104 | looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit |
1148 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1105 | the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym |
1149 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1106 | value (B<0x0000 - 0xFFFF>). |
1150 | performed in an exact manner; however, the closest match is assured. |
|
|
1151 | |
1107 | |
1152 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1108 | As with any resource value, the I<action> string may contain backslash |
|
|
1109 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1153 | number), see RESOURCES in C<man 7 X> for futher details. |
1110 | number), see RESOURCES in C<man 7 X> for further details. |
1154 | |
1111 | |
1155 | You can define a range of keysyms in one shot by providing a I<string> |
1112 | An action starts with an action prefix that selects a certain type |
1156 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1113 | of action, followed by a colon. An action string without colons is |
|
|
1114 | interpreted as a literal string to pass to the tty (as if it was |
|
|
1115 | prefixed with C<string:>). |
|
|
1116 | |
|
|
1117 | The following action prefixes are known - extensions can provide |
|
|
1118 | additional prefixes: |
|
|
1119 | |
|
|
1120 | =over 4 |
|
|
1121 | |
|
|
1122 | =item string:STRING |
|
|
1123 | |
|
|
1124 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
|
|
1125 | then the remaining C<STRING> will be passed to the program running in the |
|
|
1126 | terminal. For example, you could replace whatever Shift-Tab outputs by the |
|
|
1127 | string C<echo rm -rf /> followed by a newline: |
|
|
1128 | |
|
|
1129 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
|
|
1130 | |
|
|
1131 | This could in theory be used to completely redefine your keymap. |
|
|
1132 | |
|
|
1133 | In addition, for actions of this type, you can define a range of |
|
|
1134 | keysyms in one shot by loading the C<keysym-list> perl extension and |
|
|
1135 | providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where |
1157 | should be a character not used by the strings. |
1136 | the delimiter `/' should be a character not used by the strings. |
1158 | |
1137 | |
1159 | Its usage can be demonstrated by an example: |
1138 | Its usage can be demonstrated by an example: |
1160 | |
1139 | |
1161 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1140 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
1162 | |
1141 | |
1163 | The above line is equivalent to the following three lines: |
1142 | The above line is equivalent to the following three lines: |
1164 | |
1143 | |
1165 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1144 | URxvt.keysym.Meta-Control-0x61: string:\033<a> |
1166 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1145 | URxvt.keysym.Meta-Control-0x62: string:\033<b> |
1167 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1146 | URxvt.keysym.Meta-Control-0x63: string:\033<c> |
1168 | |
1147 | |
|
|
1148 | =item command:STRING |
|
|
1149 | |
1169 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1150 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1170 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1151 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
|
|
1152 | the opposite of C<string:> - instead of sending it to the program running |
|
|
1153 | in the terminal, it will be treated as if it were program output). This is |
|
|
1154 | most useful to feed command sequences into @@RXVT_NAME@@. |
|
|
1155 | |
1171 | example the following means "change the current locale to C<zh_CN.GBK> |
1156 | For example the following means "change the current locale to C<zh_CN.GBK> |
1172 | when Control-Meta-c is being pressed": |
1157 | when Control-Meta-c is being pressed": |
1173 | |
1158 | |
1174 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1159 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1175 | |
1160 | |
1176 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1161 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1177 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1162 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1178 | manpage. For example, the F<selection> extension (activated via |
1163 | font-switching at runtime: |
1179 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1180 | |
1164 | |
1181 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1165 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
|
|
1166 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1182 | |
1167 | |
1183 | Due the the large number of modifier combinations, a defined key mapping |
1168 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1184 | will match if at I<at least> the specified identifiers are being set, and |
1169 | info): |
1185 | no other key mappings with those and more bits are being defined. That |
|
|
1186 | means that defining a key map for C<a> will automatically provide |
|
|
1187 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1188 | mappings themselves. |
|
|
1189 | |
1170 | |
1190 | Unfortunately, this will override built-in key mappings. For example |
1171 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
1172 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1173 | |
|
|
1174 | =item builtin: |
|
|
1175 | |
|
|
1176 | The builtin action is the action that @@RXVT_NAME@@ would execute if no |
|
|
1177 | key binding existed for the key combination. The obvious use is to undo |
|
|
1178 | the effect of existing bindings. The not so obvious use is to reinstate |
|
|
1179 | bindings when another binding overrides too many modifiers. |
|
|
1180 | |
1191 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
1181 | For example if you overwrite the C<Insert> key you will disable |
1192 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
1182 | @@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke |
1193 | user-defined keymap using the C<builtin:> replacement: |
1183 | "holes" into the user-defined keymap using the C<builtin:> replacement: |
1194 | |
1184 | |
1195 | URxvt.keysym.Insert: <my insert key sequence> |
1185 | URxvt.keysym.Insert: <my insert key sequence> |
1196 | URxvt.keysym.S-Insert: builtin: |
1186 | URxvt.keysym.S-Insert: builtin: |
1197 | |
1187 | |
1198 | The first line defines a mapping for C<Insert> and I<any> combination |
1188 | The first line defines a mapping for C<Insert> and I<any> combination |
1199 | of modifiers. The second line re-establishes the default mapping for |
1189 | of modifiers. The second line re-establishes the default mapping for |
1200 | C<Shift-Insert>. |
1190 | C<Shift-Insert>. |
1201 | |
1191 | |
1202 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1192 | =item builtin-string: |
1203 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
|
|
1204 | font-switching at runtime: |
|
|
1205 | |
1193 | |
1206 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1194 | This action is mainly useful to restore string mappings for keys that |
1207 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1195 | have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit |
|
|
1196 | difficult to explain - basically, this action will send the string to the |
|
|
1197 | application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in |
|
|
1198 | action for it. |
1208 | |
1199 | |
1209 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1200 | An example might make it clearer: @@RXVT_NAME@@ normally pastes the |
1210 | info): |
1201 | selection when you press C<Shift-Insert>. With the following bindings, it |
|
|
1202 | would instead emit the (undocumented, but what applications running in the |
|
|
1203 | terminal might expect) sequence C<ESC [ 2 $> instead: |
1211 | |
1204 | |
1212 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1205 | URxvt.keysym.S-Insert: builtin-string: |
1213 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1206 | URxvt.keysym.C-S-Insert: builtin: |
|
|
1207 | |
|
|
1208 | The first line disables the paste functionality for that key |
|
|
1209 | combination, and the second reinstates the default behaviour for |
|
|
1210 | C<Control-Shift-Insert>, which would otherwise be overridden. |
|
|
1211 | |
|
|
1212 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
|
|
1213 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
|
|
1214 | this: |
|
|
1215 | |
|
|
1216 | URxvt.keysym.C-M-c: builtin-string: |
|
|
1217 | URxvt.keysym.C-M-v: builtin-string: |
|
|
1218 | |
|
|
1219 | =item EXTENSION:STRING |
|
|
1220 | |
|
|
1221 | An action of this form invokes the action B<STRING>, if any, provided |
|
|
1222 | by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will |
|
|
1223 | be loaded automatically if necessary. |
|
|
1224 | |
|
|
1225 | Not all extensions define actions, but popular extensions that do |
|
|
1226 | include the I<selection> and I<matcher> extensions (documented in their |
|
|
1227 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
|
|
1228 | respectively). |
|
|
1229 | |
|
|
1230 | From the silly examples department, this will rot13-"encrypt" |
|
|
1231 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
|
|
1232 | keyboards: |
|
|
1233 | |
|
|
1234 | URxvt.keysym.M-C-c: selection:rot13 |
|
|
1235 | |
|
|
1236 | =item perl:STRING *DEPRECATED* |
|
|
1237 | |
|
|
1238 | This is a deprecated way of invoking commands provided by perl |
|
|
1239 | extensions. It is still supported, but should not be used anymore. |
|
|
1240 | |
|
|
1241 | =back |
1214 | |
1242 | |
1215 | =item B<perl-ext-common>: I<string> |
1243 | =item B<perl-ext-common>: I<string> |
1216 | |
1244 | |
1217 | =item B<perl-ext>: I<string> |
1245 | =item B<perl-ext>: I<string> |
1218 | |
1246 | |
… | |
… | |
1220 | use in this terminal instance; option B<-pe>. |
1248 | use in this terminal instance; option B<-pe>. |
1221 | |
1249 | |
1222 | Extension names can be prefixed with a C<-> sign to prohibit using |
1250 | Extension names can be prefixed with a C<-> sign to prohibit using |
1223 | them. This can be useful to selectively disable some extensions loaded |
1251 | them. This can be useful to selectively disable some extensions loaded |
1224 | by default, or specified via the C<perl-ext-common> resource. For |
1252 | by default, or specified via the C<perl-ext-common> resource. For |
1225 | example, C<default,-selection> will use all the default extension except |
1253 | example, C<default,-selection> will use all the default extensions except |
1226 | C<selection>. |
1254 | C<selection>. |
1227 | |
1255 | |
1228 | Extension names can also be followed by an argument in angle brackets |
1256 | The default set includes the C<selection>, C<option-popup>, |
1229 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1257 | C<selection-popup>, C<readline> and C<searchable-scrollback> |
1230 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1258 | extensions, and extensions which are mentioned in B<keysym> resources. |
1231 | multiple times with different arguments will pass multiple arguments to |
1259 | |
1232 | the extension. |
1260 | Any extension such that a corresponding resource is given on the |
|
|
1261 | command line is automatically appended to B<perl-ext>. |
1233 | |
1262 | |
1234 | Each extension is looked up in the library directories, loaded if |
1263 | Each extension is looked up in the library directories, loaded if |
1235 | necessary, and bound to the current terminal instance. |
1264 | necessary, and bound to the current terminal instance. When the library |
|
|
1265 | search path contains multiple extension files of the same name, then the |
|
|
1266 | first one found will be used. |
1236 | |
1267 | |
1237 | If both of these resources are the empty string, then the perl |
1268 | If both of these resources are the empty string, then the perl interpreter |
1238 | interpreter will not be initialized. The idea behind two options is that |
1269 | will not be initialized. The rationale for having two options is that |
1239 | B<perl-ext-common> will be used for extensions that should be available to |
1270 | B<perl-ext-common> will be used for extensions that should be available to |
1240 | all instances, while B<perl-ext> is used for specific instances. |
1271 | all instances, while B<perl-ext> is used for specific instances. |
1241 | |
1272 | |
1242 | =item B<perl-eval>: I<string> |
1273 | =item B<perl-eval>: I<string> |
1243 | |
1274 | |
… | |
… | |
1245 | the @@RXVT_NAME@@perl(3) manpage. |
1276 | the @@RXVT_NAME@@perl(3) manpage. |
1246 | |
1277 | |
1247 | =item B<perl-lib>: I<path> |
1278 | =item B<perl-lib>: I<path> |
1248 | |
1279 | |
1249 | Colon-separated list of additional directories that hold extension |
1280 | Colon-separated list of additional directories that hold extension |
1250 | scripts. When looking for extensions specified by the C<perl> resource, |
1281 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
1251 | @@RXVT_NAME@@ will first look in these directories and then in |
1282 | in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
1252 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1283 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1253 | |
1284 | |
1254 | See the @@RXVT_NAME@@perl(3) manpage. |
1285 | See the @@RXVT_NAME@@perl(3) manpage. |
1255 | |
1286 | |
1256 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1287 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1257 | |
1288 | |
… | |
… | |
1261 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1292 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1262 | |
1293 | |
1263 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1294 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1264 | for details. |
1295 | for details. |
1265 | |
1296 | |
1266 | =item B<searchable-scrollback:> I<keysym> |
1297 | =item B<searchable-scrollback:> I<keysym> *DEPRECATED* |
1267 | |
1298 | |
1268 | Sets the hotkey that starts the incremental scrollback buffer search |
1299 | This resource is deprecated and will be removed. Use a B<keysym> resource |
1269 | (default: C<M-s>). |
1300 | instead, e.g.: |
1270 | |
1301 | |
|
|
1302 | URxvt.keysym.M-s: searchable-scrollback:start |
|
|
1303 | |
1271 | =item B<urlLauncher>: I<string> |
1304 | =item B<url-launcher>: I<string> |
1272 | |
1305 | |
1273 | Specifies the program to be started with a URL argument. Used by the |
1306 | Specifies the program to be started with a URL argument. Used by the |
1274 | C<selection-popup> and C<matcher> perl extensions. |
1307 | C<selection-popup> and C<matcher> perl extensions. |
1275 | |
1308 | |
1276 | =item B<transient-for>: I<windowid> |
1309 | =item B<transient-for>: I<windowid> |
… | |
… | |
1279 | |
1312 | |
1280 | =item B<override-redirect>: I<boolean> |
1313 | =item B<override-redirect>: I<boolean> |
1281 | |
1314 | |
1282 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1315 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1283 | it almost invisible to window managers; option B<-override-redirect>. |
1316 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1317 | |
|
|
1318 | =item B<iso14755:> I<boolean> |
|
|
1319 | |
|
|
1320 | Turn on/off ISO 14755 (default enabled). |
1284 | |
1321 | |
1285 | =item B<iso14755_52:> I<boolean> |
1322 | =item B<iso14755_52:> I<boolean> |
1286 | |
1323 | |
1287 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1324 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1288 | |
1325 | |
… | |
… | |
1340 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1377 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1341 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1378 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1342 | |
1379 | |
1343 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1380 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1344 | inserted too. |
1381 | inserted too. |
|
|
1382 | |
|
|
1383 | rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and |
|
|
1384 | <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first |
|
|
1385 | binding causes the value of the internal selection to be copied to the |
|
|
1386 | CLIPBOARD selection, while the second binding causes the value of the |
|
|
1387 | CLIPBOARD selection to be inserted. |
1345 | |
1388 | |
1346 | =back |
1389 | =back |
1347 | |
1390 | |
1348 | =head1 CHANGING FONTS |
1391 | =head1 CHANGING FONTS |
1349 | |
1392 | |
… | |
… | |
1431 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1474 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1432 | it can be seen via the I<who(1)> command, and can accept messages. To |
1475 | it can be seen via the I<who(1)> command, and can accept messages. To |
1433 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1476 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1434 | on some systems or setgid to root or to some other group on others. |
1477 | on some systems or setgid to root or to some other group on others. |
1435 | |
1478 | |
1436 | =head1 COLORS AND GRAPHICS |
1479 | =head1 COLOURS AND GRAPHICS |
1437 | |
1480 | |
1438 | In addition to the default foreground and background colours, |
1481 | In addition to the default foreground and background colours, |
1439 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1482 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1440 | high-intensity bold/blink versions of the same). Here is a list of the |
1483 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1441 | colours with their names. |
1484 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1485 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1486 | |
|
|
1487 | B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes |
|
|
1488 | C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the |
|
|
1489 | number of 24-bit colours that can be used is limited: an internal 7x7x5 (256 |
|
|
1490 | colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the |
|
|
1491 | 24-bit colour space. When indexing collisions happen, the nearest old colour in |
|
|
1492 | the cube will be adapted to the new 24-bit RGB colour. That means one cannot |
|
|
1493 | use many similar 24-bit colours. It's typically not a problem in common |
|
|
1494 | scenarios. |
|
|
1495 | |
|
|
1496 | Here is a list of the ANSI colours with their names. |
1442 | |
1497 | |
1443 | =begin table |
1498 | =begin table |
1444 | |
1499 | |
1445 | B<color0> (black) = Black |
1500 | B<color0> (black) = Black |
1446 | B<color1> (red) = Red3 |
1501 | B<color1> (red) = Red3 |
… | |
… | |
1466 | It is also possible to specify the colour values of B<foreground>, |
1521 | It is also possible to specify the colour values of B<foreground>, |
1467 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1522 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1468 | a number 0-15, as a convenient shorthand to reference the colour name of |
1523 | a number 0-15, as a convenient shorthand to reference the colour name of |
1469 | color0-color15. |
1524 | color0-color15. |
1470 | |
1525 | |
1471 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1526 | The following text gives values for the standard 88 colour mode (and |
1472 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1527 | values for the 256 colour mode in parentheses). |
1473 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1474 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1475 | |
1528 | |
|
|
1529 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1530 | |
|
|
1531 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1532 | index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5 |
|
|
1533 | |
|
|
1534 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1535 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1536 | the RGB cube. |
|
|
1537 | |
1476 | Together, all those colours implement the 88 colour xterm colours. Only |
1538 | Together, all those colours implement the 88 (256) colour xterm |
1477 | the first 16 can be changed using resources currently, the rest can only |
1539 | colours. Only the first 16 can be changed using resources currently, the |
1478 | be changed via command sequences ("escape codes"). |
1540 | rest can only be changed via command sequences ("escape codes"). |
|
|
1541 | |
|
|
1542 | Applications are advised to use terminfo or command sequences to discover |
|
|
1543 | number and RGB values of all colours (yes, you can query this...). |
1479 | |
1544 | |
1480 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1545 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1481 | always swapping the foreground/background colours. This is in contrast to |
1546 | always swapping the foreground/background colours. This is in contrast to |
1482 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1547 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1483 | been specified. For example, |
1548 | been specified. For example, |
1484 | |
1549 | |
1485 | =over 4 |
|
|
1486 | |
|
|
1487 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1550 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1488 | |
1551 | |
1489 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1552 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1490 | on White. |
1553 | White. |
1491 | |
|
|
1492 | =back |
|
|
1493 | |
1554 | |
1494 | =head2 ALPHA CHANNEL SUPPORT |
1555 | =head2 ALPHA CHANNEL SUPPORT |
1495 | |
1556 | |
1496 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1557 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1497 | their act together, rxvt-unicode will do it's own alpha channel management: |
1558 | their act together, rxvt-unicode will do its own alpha channel management: |
1498 | |
1559 | |
1499 | You can prefix any color with an opaquenes percentage enclosed in |
1560 | You can prefix any colour with an opaqueness percentage enclosed in |
1500 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1561 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1501 | (0-100) that specifies the opacity of the color, where C<0> is completely |
1562 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1502 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1563 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1503 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1564 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1504 | is the recommended format to specify transparency values, and works with |
1565 | is the recommended format to specify transparency values, and works with |
1505 | all ways to specify a colour. |
1566 | all ways to specify a colour. |
1506 | |
1567 | |
… | |
… | |
1584 | |
1645 | |
1585 | =item B<SHELL> |
1646 | =item B<SHELL> |
1586 | |
1647 | |
1587 | The shell to be used for command execution, defaults to C</bin/sh>. |
1648 | The shell to be used for command execution, defaults to C</bin/sh>. |
1588 | |
1649 | |
1589 | =item B<RXVT_SOCKET> |
1650 | =item B<RXVT_SOCKET> [I<sic>] |
1590 | |
1651 | |
1591 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1652 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1592 | @@RXVT_NAME@@d(1). |
1653 | @@RXVT_NAME@@d(1). |
1593 | |
1654 | |
1594 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1655 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1656 | |
|
|
1657 | =item B<URXVT_PERL_LIB> |
|
|
1658 | |
|
|
1659 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1660 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1661 | directory. |
|
|
1662 | |
|
|
1663 | =item B<URXVT_PERL_VERBOSITY> |
|
|
1664 | |
|
|
1665 | See L<@@RXVT_NAME@@perl>(3). |
1595 | |
1666 | |
1596 | =item B<HOME> |
1667 | =item B<HOME> |
1597 | |
1668 | |
1598 | Used to locate the default directory for the unix domain socket for |
1669 | Used to locate the default directory for the unix domain socket for |
1599 | daemon communications and to locate various resource files (such as |
1670 | daemon communications and to locate various resource files (such as |
1600 | C<.Xdefaults>) |
1671 | C<.Xdefaults>) |
1601 | |
1672 | |
1602 | =item B<XAPPLRESDIR> |
1673 | =item B<XAPPLRESDIR> |
1603 | |
1674 | |
1604 | Directory where various X resource files are being located. |
1675 | Directory where application-specific X resource files are located. |
1605 | |
1676 | |
1606 | =item B<XENVIRONMENT> |
1677 | =item B<XENVIRONMENT> |
1607 | |
1678 | |
1608 | If set and accessible, gives the name of a X resource file to be loaded by |
1679 | If set and accessible, gives the name of a X resource file to be loaded by |
1609 | @@RXVT_NAME@@. |
1680 | @@RXVT_NAME@@. |
… | |
… | |
1614 | |
1685 | |
1615 | =over 4 |
1686 | =over 4 |
1616 | |
1687 | |
1617 | =item B</usr/lib/X11/rgb.txt> |
1688 | =item B</usr/lib/X11/rgb.txt> |
1618 | |
1689 | |
1619 | Color names. |
1690 | Colour names. |
1620 | |
1691 | |
1621 | =back |
1692 | =back |
1622 | |
1693 | |
1623 | =head1 SEE ALSO |
1694 | =head1 SEE ALSO |
1624 | |
1695 | |
|
|
1696 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1625 | @@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) |
1697 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1626 | |
1698 | |
1627 | =head1 CURRENT PROJECT COORDINATOR |
1699 | =head1 CURRENT PROJECT COORDINATOR |
1628 | |
1700 | |
1629 | =over 4 |
1701 | =over 4 |
1630 | |
1702 | |
1631 | =item Project Coordinator |
1703 | =item Project Coordinator |
1632 | |
1704 | |
1633 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1705 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1634 | |
1706 | |
1635 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1707 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1636 | |
1708 | |
1637 | =back |
1709 | =back |
1638 | |
1710 | |
… | |
… | |
1642 | |
1714 | |
1643 | =item John Bovey |
1715 | =item John Bovey |
1644 | |
1716 | |
1645 | University of Kent, 1992, wrote the original Xvt. |
1717 | University of Kent, 1992, wrote the original Xvt. |
1646 | |
1718 | |
1647 | =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1719 | =item Rob Nation <nation@rocket.sanders.lockheed.com> |
1648 | |
1720 | |
1649 | very heavily modified Xvt and came up with Rxvt |
1721 | very heavily modified Xvt and came up with Rxvt |
1650 | |
1722 | |
1651 | =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1723 | =item Angelo Haritsis <ah@doc.ic.ac.uk> |
1652 | |
1724 | |
1653 | wrote the Greek Keyboard Input (no longer in code) |
1725 | wrote the Greek Keyboard Input (no longer in code) |
1654 | |
1726 | |
1655 | =item mj olesen L<< <olesen@me.QueensU.CA> >> |
1727 | =item mj olesen <olesen@me.QueensU.CA> |
1656 | |
1728 | |
1657 | Wrote the menu system. |
1729 | Wrote the menu system. |
1658 | |
1730 | |
1659 | Project Coordinator (changes.txt 2.11 to 2.21) |
1731 | Project Coordinator (changes.txt 2.11 to 2.21) |
1660 | |
1732 | |
1661 | =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1733 | =item Oezguer Kesim <kesim@math.fu-berlin.de> |
1662 | |
1734 | |
1663 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1735 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1664 | |
1736 | |
1665 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1737 | =item Geoff Wing <gcw@pobox.com> |
1666 | |
1738 | |
1667 | Rewrote screen display and text selection routines. |
1739 | Rewrote screen display and text selection routines. |
1668 | |
1740 | |
1669 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1741 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1670 | |
1742 | |
1671 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1743 | =item Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1672 | |
1744 | |
1673 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1745 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1674 | extension, random hacks, numerous bugfixes and extensions. |
1746 | extension, random hacks, numerous bugfixes and extensions. |
1675 | |
1747 | |
1676 | Project Coordinator (Changes 1.0 -) |
1748 | Project Coordinator (Changes 1.0 -) |
1677 | |
1749 | |
1678 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1750 | =item Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
1679 | |
1751 | |
1680 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1752 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
1681 | |
1753 | |
1682 | =back |
1754 | =back |
1683 | |
1755 | |