… | |
… | |
84 | far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
84 | far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
85 | Orange'. |
85 | Orange'. |
86 | |
86 | |
87 | The following options are available: |
87 | The following options are available: |
88 | |
88 | |
89 | =over 4 |
89 | =over |
90 | |
90 | |
91 | =item B<-help>, B<--help> |
91 | =item B<-help>, B<--help> |
92 | |
92 | |
93 | Print out a message describing available options. |
93 | Print out a message describing available options. |
94 | |
94 | |
… | |
… | |
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> |
… | |
… | |
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 | |
132 | |
127 | =item B<-tr>|B<+tr> |
133 | =item B<-fps> I<number> |
128 | |
134 | |
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
135 | Compile I<frills>: Set the refresh interval (in frames per second or |
130 | |
136 | negative seconds); resource B<refreshRate>. |
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 | |
137 | |
137 | =item B<-fade> I<number> |
138 | =item B<-fade> I<number> |
138 | |
139 | |
139 | Fade the text by the given percentage when focus is lost. Small values |
140 | 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 |
141 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
143 | =item B<-fadecolor> I<colour> |
144 | =item B<-fadecolor> I<colour> |
144 | |
145 | |
145 | Fade to this colour when fading is used (see B<-fade>). The default colour |
146 | Fade to this colour when fading is used (see B<-fade>). The default colour |
146 | is opaque black. resource B<fadeColor>. |
147 | is opaque black. resource B<fadeColor>. |
147 | |
148 | |
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 colours 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> - colour 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> |
149 | =item B<-icon> I<file> |
188 | |
150 | |
189 | Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This |
151 | Compile I<pixbuf>: Use the specified image as application icon. This |
190 | is used by many window managers, taskbars and pagers to represent the |
152 | is used by many window managers, taskbars and pagers to represent the |
191 | application window; resource I<iconFile>. |
153 | application window; resource I<iconFile>. |
192 | |
154 | |
193 | =item B<-bg> I<colour> |
155 | =item B<-bg> I<colour> |
194 | |
156 | |
195 | Window background colour; resource B<background>. |
157 | Window background colour; resource B<background>. |
196 | |
158 | |
197 | =item B<-fg> I<colour> |
159 | =item B<-fg> I<colour> |
198 | |
160 | |
199 | Window foreground colour; resource B<foreground>. |
161 | Window foreground colour; resource B<foreground>. |
200 | |
|
|
201 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
|
|
202 | |
|
|
203 | Compile I<afterimage> or I<pixbuf>: 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 | |
162 | |
208 | =item B<-cr> I<colour> |
163 | =item B<-cr> I<colour> |
209 | |
164 | |
210 | The cursor colour; resource B<cursorColor>. |
165 | The cursor colour; resource B<cursorColor>. |
211 | |
166 | |
… | |
… | |
270 | |
225 | |
271 | =item B<-ls>|B<+ls> |
226 | =item B<-ls>|B<+ls> |
272 | |
227 | |
273 | Start as a login-shell/sub-shell; resource B<loginShell>. |
228 | Start as a login-shell/sub-shell; resource B<loginShell>. |
274 | |
229 | |
|
|
230 | =item B<-mc> I<milliseconds> |
|
|
231 | |
|
|
232 | Specify the maximum time between multi-click selections. |
|
|
233 | |
275 | =item B<-ut>|B<+ut> |
234 | =item B<-ut>|B<+ut> |
276 | |
235 | |
277 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
236 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
278 | B<utmpInhibit>. |
237 | B<utmpInhibit>. |
279 | |
238 | |
… | |
… | |
357 | |
316 | |
358 | =item B<-override-redirect> |
317 | =item B<-override-redirect> |
359 | |
318 | |
360 | Compile I<frills>: Sets override-redirect on the window; resource |
319 | Compile I<frills>: Sets override-redirect on the window; resource |
361 | B<override-redirect>. |
320 | B<override-redirect>. |
|
|
321 | |
|
|
322 | =item B<-dockapp> |
|
|
323 | |
|
|
324 | Sets the initial state of the window to WithdrawnState, which makes |
|
|
325 | window managers that support this extension treat it as a dockapp. |
362 | |
326 | |
363 | =item B<-sbg> |
327 | =item B<-sbg> |
364 | |
328 | |
365 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
329 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
366 | drawing characters and just rely on what the specified fonts provide. Use |
330 | drawing characters and just rely on what the specified fonts provide. Use |
… | |
… | |
421 | =item B<-pt> I<style> |
385 | =item B<-pt> I<style> |
422 | |
386 | |
423 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
387 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
424 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
388 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
425 | |
389 | |
|
|
390 | If the perl extension C<xim-onthespot> is used (which is the default), |
|
|
391 | then additionally the C<OnTheSpot> preedit type is available. |
|
|
392 | |
426 | =item B<-im> I<text> |
393 | =item B<-im> I<text> |
427 | |
394 | |
428 | Compile I<XIM>: input method name. resource B<inputMethod>. |
395 | Compile I<XIM>: input method name. resource B<inputMethod>. |
429 | |
396 | |
430 | =item B<-imlocale> I<string> |
397 | =item B<-imlocale> I<string> |
… | |
… | |
444 | Change the meaning of triple-click selection with the left mouse |
411 | Change the meaning of triple-click selection with the left mouse |
445 | button. Only effective when the original (non-perl) selection code is |
412 | button. Only effective when the original (non-perl) selection code is |
446 | in-use. Instead of selecting a full line it will extend the selection to |
413 | in-use. Instead of selecting a full line it will extend the selection to |
447 | the end of the logical line only. resource B<tripleclickwords>. |
414 | the end of the logical line only. resource B<tripleclickwords>. |
448 | |
415 | |
|
|
416 | =item B<-dpb>|B<+dpb> |
|
|
417 | |
|
|
418 | Compile frills: Disable (or enable) emitting bracketed paste mode |
|
|
419 | sequences (default enabled). Bracketed paste mode allows programs |
|
|
420 | to detect when something is pasted. Since more and more programs |
|
|
421 | abuse this, these sequences can be disabled. The command sequences to |
|
|
422 | enable and query paste mode will still work, but the actual bracket |
|
|
423 | sequences will no longer be emitted. You can also toggle this from the |
|
|
424 | ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>. |
|
|
425 | |
449 | =item B<-insecure> |
426 | =item B<-insecure> |
450 | |
427 | |
451 | Enable "insecure" mode, which currently enables most of the escape |
428 | Enable "insecure" mode, which currently enables most of the escape |
452 | sequences that echo strings. See the resource B<insecure> for more |
429 | sequences that echo strings. See the resource B<insecure> for more |
453 | info. |
430 | info. |
… | |
… | |
465 | |
442 | |
466 | =item B<-ssr>|B<+ssr> |
443 | =item B<-ssr>|B<+ssr> |
467 | |
444 | |
468 | Turn on/off secondary screen scroll (default enabled); resource |
445 | Turn on/off secondary screen scroll (default enabled); resource |
469 | B<secondaryScroll>. |
446 | B<secondaryScroll>. |
|
|
447 | |
|
|
448 | =item B<-rm> I<mode> |
|
|
449 | |
|
|
450 | Compile I<frills>: Sets long line rewrapping behaviour on window resizes |
|
|
451 | to one of B<auto> (the default), B<always> or B<never>. The latter two |
|
|
452 | modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback |
|
|
453 | is non-empty, and wings lines (acts like B<never>) otherwise; resource |
|
|
454 | B<rewrapMode>. |
470 | |
455 | |
471 | =item B<-hold>|B<+hold> |
456 | =item B<-hold>|B<+hold> |
472 | |
457 | |
473 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
458 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
474 | will not immediately destroy its window when the program executed within |
459 | will not immediately destroy its window when the program executed within |
… | |
… | |
553 | |
538 | |
554 | # now communicate with rxvt |
539 | # now communicate with rxvt |
555 | my $slave = $pty->slave; |
540 | my $slave = $pty->slave; |
556 | while (<$slave>) { print $slave "got <$_>\n" } |
541 | while (<$slave>) { print $slave "got <$_>\n" } |
557 | |
542 | |
|
|
543 | Note that, despite what the name might imply, the file descriptor does not |
|
|
544 | need to be a pty, it can be a bi-directional pipe as well (e.g. a unix |
|
|
545 | domain or tcp socket). While tty operations cannot be done in this case, |
|
|
546 | B<@@RXVT_NAME@@> can still be remote controlled with it: |
|
|
547 | |
|
|
548 | use Socket; |
|
|
549 | use Fcntl; |
|
|
550 | |
|
|
551 | socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC; |
|
|
552 | fcntl $slave, Fcntl::F_SETFD, 0; |
|
|
553 | system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &"; |
|
|
554 | close $slave; |
|
|
555 | |
|
|
556 | syswrite $URXVT, "Type a secret password: "; |
|
|
557 | my $secret = do { local $/ = "\r"; <$URXVT> }; |
|
|
558 | print "Not so secret anymore: $secret\n"; |
|
|
559 | |
558 | =item B<-pe> I<string> |
560 | =item B<-pe> I<string> |
559 | |
561 | |
560 | Comma-separated list of perl extension scripts to use (or not to use) in |
562 | Comma-separated list of perl extension scripts to use (or not to use) in |
561 | this terminal instance. See resource B<perl-ext> for details. |
563 | this terminal instance. See resource B<perl-ext> for details. |
562 | |
564 | |
… | |
… | |
571 | You can set and change the resources using X11 tools like B<xrdb>. Many |
573 | You can set and change the resources using X11 tools like B<xrdb>. Many |
572 | distribution do also load settings from the B<~/.Xresources> file when X |
574 | distribution do also load settings from the B<~/.Xresources> file when X |
573 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
575 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
574 | with later settings overwriting earlier ones: |
576 | with later settings overwriting earlier ones: |
575 | |
577 | |
576 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
577 | 2. app-defaults file in $XAPPLRESDIR |
578 | 1. app-defaults file in $XAPPLRESDIR |
|
|
579 | 2. $HOME/.Xdefaults |
578 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
580 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
579 | 4. SCREEN_RESOURCES for the current screen |
581 | 4. SCREEN_RESOURCES property on root-window of the current screen |
580 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
582 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
581 | 6. resources specified via -xrm on the commandline |
583 | 6. resources specified via -xrm on the commandline |
582 | |
584 | |
583 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
585 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
584 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
586 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
… | |
… | |
589 | be used. Command-line arguments can be used to override resource |
591 | be used. Command-line arguments can be used to override resource |
590 | settings. The following resources are supported (you might want to |
592 | settings. The following resources are supported (you might want to |
591 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
593 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
592 | extensions not documented here): |
594 | extensions not documented here): |
593 | |
595 | |
594 | =over 4 |
596 | =over |
595 | |
597 | |
596 | =item B<depth:> I<bitdepth> |
598 | =item B<depth:> I<bitdepth> |
597 | |
599 | |
598 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
600 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
599 | option B<-depth>. |
601 | option B<-depth>. |
… | |
… | |
700 | |
702 | |
701 | B<False>: specify that everything is to be displayed, even |
703 | B<False>: specify that everything is to be displayed, even |
702 | if the refresh is too fast for the human eye to read anything (or the |
704 | if the refresh is too fast for the human eye to read anything (or the |
703 | monitor to display anything); option B<+ss>. |
705 | monitor to display anything); option B<+ss>. |
704 | |
706 | |
705 | =item B<transparent:> I<boolean> |
707 | =item B<refreshRate:> I<number> |
706 | |
708 | |
707 | Turn on/off illusion of a transparent window background. |
709 | Compile I<frills>: When positive, sets the maximum refreshes per second |
708 | |
710 | (the default is C<60>). When zero or negative, sets the minimum interval |
709 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
711 | between refreshes, negated. That is, positive numbers limit the number |
710 | future versions. |
712 | of refreshes per second to that number, similar to a fps limiter in |
711 | |
713 | games. A negative number gets negated and directly sets the minimum |
712 | I<Please address all transparency related issues to Sasha Vasko at |
714 | interval between refreshes, that is, C<10> and C<-0.1> both specify |
713 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
715 | the same refresh interval (likewise C<50> and C<0.02>). Finally, zero |
|
|
716 | makes @@RXVT_NAME@@ refresh as fast as possible. Fractional values are |
|
|
717 | supported; option B<-fps>. |
714 | |
718 | |
715 | =item B<fading:> I<number> |
719 | =item B<fading:> I<number> |
716 | |
720 | |
717 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
721 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
718 | |
722 | |
719 | =item B<fadeColor:> I<colour> |
723 | =item B<fadeColor:> I<colour> |
720 | |
724 | |
721 | Fade to this colour, when fading is used (see B<fading:>). The default |
725 | Fade to this colour, when fading is used (see B<fading:>). The default |
722 | colour is black; option B<-fadecolor>. |
726 | colour is black; option B<-fadecolor>. |
723 | |
727 | |
724 | =item B<tintColor:> I<colour> |
|
|
725 | |
|
|
726 | Tint the transparent background pixmap with the given colour; option |
|
|
727 | B<-tint>. |
|
|
728 | |
|
|
729 | =item B<shading:> I<number> |
|
|
730 | |
|
|
731 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
|
|
732 | in addition to tinting it; option B<-sh>. |
|
|
733 | |
|
|
734 | =item B<blendType:> I<string> |
|
|
735 | |
|
|
736 | Specify background blending type; option B<-blt>. |
|
|
737 | |
|
|
738 | =item B<blurRadius:> I<number> |
|
|
739 | |
|
|
740 | Apply gaussian blur with the specified radius to the transparent |
|
|
741 | background image; option B<-blr>. |
|
|
742 | |
|
|
743 | =item B<iconFile:> I<file> |
728 | =item B<iconFile:> I<file> |
744 | |
729 | |
745 | Set the application icon pixmap; option B<-icon>. |
730 | Set the application icon pixmap; option B<-icon>. |
746 | |
731 | |
747 | =item B<scrollColor:> I<colour> |
732 | =item B<scrollColor:> I<colour> |
… | |
… | |
755 | |
740 | |
756 | =item B<borderColor:> I<colour> |
741 | =item B<borderColor:> I<colour> |
757 | |
742 | |
758 | The colour of the border around the text area and between the scrollbar |
743 | The colour of the border around the text area and between the scrollbar |
759 | and the text. |
744 | and the text. |
760 | |
|
|
761 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
|
|
762 | |
|
|
763 | Use the specified image file for the background and also |
|
|
764 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
|
|
765 | (default C<100x100+50+50>) in which B<"W" / "H"> specify the |
|
|
766 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
|
|
767 | centre (percent). A scale of 0 displays the image with tiling. |
|
|
768 | The maximum permitted scale is 1000. |
|
|
769 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
770 | Supported operations are: |
|
|
771 | |
|
|
772 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
773 | propscale will scale image keeping proportions |
|
|
774 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
775 | hscale will scale image horizontally to the window size |
|
|
776 | vscale will scale image vertically to the window size |
|
|
777 | scale will scale image to match window size |
|
|
778 | root will tile image as if it was a root window background, auto-adjusting |
|
|
779 | whenever terminal window moves |
|
|
780 | |
|
|
781 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
782 | blended over transparency image using either alpha-blending, or any |
|
|
783 | other blending type, specified with B<-blt "type"> option. |
|
|
784 | |
|
|
785 | =item B<path:> I<path> |
|
|
786 | |
|
|
787 | Specify the colon-delimited search path for finding background image files. |
|
|
788 | |
745 | |
789 | =item B<font:> I<fontlist> |
746 | =item B<font:> I<fontlist> |
790 | |
747 | |
791 | Select the fonts to be used. This is a comma separated list of font names |
748 | Select the fonts to be used. This is a comma separated list of font names |
792 | that are checked in order when trying to find glyphs for characters. The |
749 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
889 | |
846 | |
890 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
847 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
891 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
848 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
892 | [default]; option B<+ls>. |
849 | [default]; option B<+ls>. |
893 | |
850 | |
|
|
851 | =item B<multiClickTime:> I<number> |
|
|
852 | |
|
|
853 | Specify the maximum time in milliseconds between multi-click select |
|
|
854 | events. The default is 500 milliseconds; option B<-mc>. |
|
|
855 | |
894 | =item B<utmpInhibit:> I<boolean> |
856 | =item B<utmpInhibit:> I<boolean> |
895 | |
857 | |
896 | B<True>: inhibit writing record into the system log file B<utmp>; |
858 | B<True>: inhibit writing record into the system log file B<utmp>; |
897 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
859 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
898 | [default]; option B<+ut>. |
860 | [default]; option B<+ut>. |
… | |
… | |
915 | =item B<scrollstyle:> I<mode> |
877 | =item B<scrollstyle:> I<mode> |
916 | |
878 | |
917 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
879 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
918 | the author's favourite. |
880 | the author's favourite. |
919 | |
881 | |
|
|
882 | =item B<thickness:> I<number> |
|
|
883 | |
|
|
884 | Set the scrollbar width in pixels. |
|
|
885 | |
920 | =item B<scrollBar:> I<boolean> |
886 | =item B<scrollBar:> I<boolean> |
921 | |
887 | |
922 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
888 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
923 | disable the scrollbar; option B<+sb>. |
889 | disable the scrollbar; option B<+sb>. |
924 | |
890 | |
… | |
… | |
937 | Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
903 | Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
938 | thumb with the pointer on middle button press/drag. |
904 | thumb with the pointer on middle button press/drag. |
939 | |
905 | |
940 | =item B<scrollTtyOutput:> I<boolean> |
906 | =item B<scrollTtyOutput:> I<boolean> |
941 | |
907 | |
942 | B<True>: scroll to bottom when tty receives output; option B<-si>. |
908 | B<True>: scroll to bottom when tty receives output; option B<+si>. |
943 | B<False>: do not scroll to bottom when tty receives output; option |
909 | B<False>: do not scroll to bottom when tty receives output; option |
944 | B<+si>. |
910 | B<-si>. |
945 | |
911 | |
946 | =item B<scrollWithBuffer:> I<boolean> |
912 | =item B<scrollWithBuffer:> I<boolean> |
947 | |
913 | |
948 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
914 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
949 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
915 | try to show the same lines) and B<scrollTtyOutput> is False; option |
950 | with scrollback buffer when tty receives new lines; option B<+sw>. |
916 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
917 | new lines; option B<+sw>. |
951 | |
918 | |
952 | =item B<scrollTtyKeypress:> I<boolean> |
919 | =item B<scrollTtyKeypress:> I<boolean> |
953 | |
920 | |
954 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
921 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
955 | are those which are intercepted by rxvt-unicode for special handling and |
922 | are those which are intercepted by rxvt-unicode for special handling and |
956 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
923 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
957 | bottom when a non-special key is pressed; option B<+sk>. |
924 | bottom when a non-special key is pressed; option B<+sk>. |
958 | |
925 | |
959 | =item B<saveLines:> I<number> |
926 | =item B<saveLines:> I<number> |
960 | |
927 | |
961 | Save I<number> lines in the scrollback buffer [default 64]. This |
928 | Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>. |
962 | resource is limited on most machines to 65535; option B<-sl>. |
|
|
963 | |
929 | |
964 | =item B<internalBorder:> I<number> |
930 | =item B<internalBorder:> I<number> |
965 | |
931 | |
966 | Internal border of I<number> pixels. This resource is limited to 100; |
932 | Internal border of I<number> pixels. This resource is limited to 100; |
967 | option B<-b>. |
933 | option B<-b>. |
… | |
… | |
1030 | |
996 | |
1031 | =item B<pointerColor2:> I<colour> |
997 | =item B<pointerColor2:> I<colour> |
1032 | |
998 | |
1033 | Mouse pointer background colour. |
999 | Mouse pointer background colour. |
1034 | |
1000 | |
|
|
1001 | =item B<pointerShape:> I<string> |
|
|
1002 | |
|
|
1003 | Compile I<frills>: Specifies the name of the mouse pointer shape |
|
|
1004 | [default B<xterm>]. See the macros in the B<X11/cursorfont.h> include |
|
|
1005 | file for possible values (omit the C<XC_> prefix). |
|
|
1006 | |
1035 | =item B<pointerBlankDelay:> I<number> |
1007 | =item B<pointerBlankDelay:> I<number> |
1036 | |
1008 | |
1037 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
1009 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
1038 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1010 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1039 | |
1011 | |
… | |
… | |
1065 | |
1037 | |
1066 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
1038 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
1067 | |
1039 | |
1068 | =item B<preeditType:> I<style> |
1040 | =item B<preeditType:> I<style> |
1069 | |
1041 | |
1070 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1042 | B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1071 | |
1043 | |
1072 | =item B<inputMethod:> I<name> |
1044 | =item B<inputMethod:> I<name> |
1073 | |
1045 | |
1074 | I<name> of inputMethod to use; option B<-im>. |
1046 | I<name> of inputMethod to use; option B<-im>. |
1075 | |
1047 | |
… | |
… | |
1093 | |
1065 | |
1094 | Change the meaning of triple-click selection with the left mouse |
1066 | Change the meaning of triple-click selection with the left mouse |
1095 | button. Instead of selecting a full line it will extend the selection to |
1067 | button. Instead of selecting a full line it will extend the selection to |
1096 | the end of the logical line only; option B<-tcw>. |
1068 | the end of the logical line only; option B<-tcw>. |
1097 | |
1069 | |
|
|
1070 | =item B<disablePasteBrackets:> I<boolean> |
|
|
1071 | |
|
|
1072 | Prevent emission of paste bracket sequences; option B<-dpb>. |
|
|
1073 | |
1098 | =item B<insecure:> I<boolean> |
1074 | =item B<insecure:> I<boolean> |
1099 | |
1075 | |
1100 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
1076 | Enable "insecure" mode. Rxvt-unicode offers some escape sequences that |
1101 | echo arbitrary strings like the icon name or the locale. This could be |
1077 | echo arbitrary strings like the icon name or the locale. This could be |
1102 | abused if somebody gets 8-bit-clean access to your display, whether |
1078 | abused if somebody gets 8-bit-clean access to your display, whether |
1103 | through a mail client displaying mail bodies unfiltered or through |
1079 | through a mail client displaying mail bodies unfiltered or through |
1104 | write(1) or any other means. Therefore, these sequences are disabled by |
1080 | write(1) or any other means. Therefore, these sequences are disabled by |
1105 | default. (Note that many other terminals, including xterm, have these |
1081 | default. (Note that many other terminals, including xterm, have these |
… | |
… | |
1123 | |
1099 | |
1124 | =item B<secondaryScreen:> I<boolean> |
1100 | =item B<secondaryScreen:> I<boolean> |
1125 | |
1101 | |
1126 | Turn on/off secondary screen (default enabled). |
1102 | Turn on/off secondary screen (default enabled). |
1127 | |
1103 | |
|
|
1104 | =item B<rewrapMode:> I<mode> |
|
|
1105 | |
|
|
1106 | Sets long line rewrap behaviour on window resize to one of B<auto> |
|
|
1107 | (default), B<always> or B<never>. |
|
|
1108 | |
1128 | =item B<secondaryScroll:> I<boolean> |
1109 | =item B<secondaryScroll:> I<boolean> |
1129 | |
1110 | |
1130 | Turn on/off secondary screen scroll (default enabled). If this |
1111 | Turn on/off secondary screen scroll (default enabled). If this |
1131 | option is enabled, scrolls on the secondary screen will change the |
1112 | option is enabled, scrolls on the secondary screen will change the |
1132 | scrollback buffer and, when secondaryScreen is off, switching |
1113 | scrollback buffer and, when secondaryScreen is off, switching |
… | |
… | |
1144 | Sets the working directory for the shell (or the command specified via |
1125 | Sets the working directory for the shell (or the command specified via |
1145 | B<-e>). The I<path> must be an absolute path and it must exist for |
1126 | B<-e>). The I<path> must be an absolute path and it must exist for |
1146 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1127 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1147 | directory will be used; option B<-cd>. |
1128 | directory will be used; option B<-cd>. |
1148 | |
1129 | |
1149 | =item B<keysym.>I<sym>: I<string> |
1130 | =item B<keysym.>I<sym>: I<action> |
1150 | |
1131 | |
1151 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1132 | Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening |
1152 | intervening resource name B<keysym.> cannot be omitted. |
1133 | resource name B<keysym.> cannot be omitted. |
1153 | |
1134 | |
1154 | The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be |
1135 | Using this resource, you can map key combinations such as |
1155 | any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
1136 | C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different |
1156 | B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, |
1137 | string than would normally result from that combination, making the |
1157 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
1138 | terminal scroll up or down the way you want it, or any other thing an |
1158 | B<2>, B<3>, B<4>, B<5>. |
1139 | extension might provide. |
|
|
1140 | |
|
|
1141 | The key combination that triggers the action, I<sym>, has the following format: |
|
|
1142 | |
|
|
1143 | (modifiers-)key |
|
|
1144 | |
|
|
1145 | Where I<modifiers> can be any combination of the following full or |
|
|
1146 | abbreviated modifier names: |
|
|
1147 | |
|
|
1148 | =begin table |
|
|
1149 | |
|
|
1150 | B<ISOLevel3> B<I> |
|
|
1151 | B<AppKeypad> B<K> |
|
|
1152 | B<Control> B<C> |
|
|
1153 | B<NumLock> B<N> |
|
|
1154 | B<Shift> B<S> |
|
|
1155 | B<Meta> B<M> I<or> B<A> |
|
|
1156 | B<Lock> B<L> |
|
|
1157 | B<Mod1> B<1> |
|
|
1158 | B<Mod2> B<2> |
|
|
1159 | B<Mod3> B<3> |
|
|
1160 | B<Mod4> B<4> |
|
|
1161 | B<Mod5> B<5> |
|
|
1162 | |
|
|
1163 | =end table |
1159 | |
1164 | |
1160 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1165 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1161 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1166 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1162 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1167 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1163 | current application keymap mode state. |
1168 | current application keymap mode state. |
1164 | |
1169 | |
1165 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
1170 | Due the the large number of modifier combinations, a key mapping will |
1166 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1171 | match if I<at least> the specified identifiers are being set, and no other |
|
|
1172 | key mappings with those and more bits are being defined. That means that |
|
|
1173 | defining a mapping for C<a> will automatically provide definitions for |
|
|
1174 | C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings |
|
|
1175 | themselves. See the C<builtin:> action, below, for a way to work around |
|
|
1176 | this when this is a problem. |
|
|
1177 | |
|
|
1178 | The spelling of I<key> depends on your implementation of X. An easy way to |
|
|
1179 | find a key name is to use the B<xev>(1) command. You can find a list by |
|
|
1180 | looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit |
1167 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1181 | the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym |
1168 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1182 | value (B<0x0000 - 0xFFFF>). |
1169 | performed in an exact manner; however, the closest match is assured. |
|
|
1170 | |
1183 | |
1171 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1184 | As with any resource value, the I<action> string may contain backslash |
|
|
1185 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1172 | number), see RESOURCES in C<man 7 X> for further details. |
1186 | number), see RESOURCES in C<man 7 X> for further details. |
1173 | |
1187 | |
1174 | You can define a range of keysyms in one shot by providing a I<string> |
1188 | An action starts with an action prefix that selects a certain type |
1175 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1189 | of action, followed by a colon. An action string without colons is |
|
|
1190 | interpreted as a literal string to pass to the tty (as if it was |
|
|
1191 | prefixed with C<string:>). |
|
|
1192 | |
|
|
1193 | The following action prefixes are known - extensions can provide |
|
|
1194 | additional prefixes: |
|
|
1195 | |
|
|
1196 | =over |
|
|
1197 | |
|
|
1198 | =item string:STRING |
|
|
1199 | |
|
|
1200 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
|
|
1201 | then the remaining C<STRING> will be passed to the program running in the |
|
|
1202 | terminal. For example, you could replace whatever Shift-Tab outputs by the |
|
|
1203 | string C<echo rm -rf /> followed by a newline: |
|
|
1204 | |
|
|
1205 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
|
|
1206 | |
|
|
1207 | This could in theory be used to completely redefine your keymap. |
|
|
1208 | |
|
|
1209 | In addition, for actions of this type, you can define a range of |
|
|
1210 | keysyms in one shot by loading the C<keysym-list> perl extension and |
|
|
1211 | providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where |
1176 | should be a character not used by the strings. |
1212 | the delimiter `/' should be a character not used by the strings. |
1177 | |
1213 | |
1178 | Its usage can be demonstrated by an example: |
1214 | Its usage can be demonstrated by an example: |
1179 | |
1215 | |
1180 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1216 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
1181 | |
1217 | |
1182 | The above line is equivalent to the following three lines: |
1218 | The above line is equivalent to the following three lines: |
1183 | |
1219 | |
1184 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1220 | URxvt.keysym.Meta-Control-0x61: string:\033<a> |
1185 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1221 | URxvt.keysym.Meta-Control-0x62: string:\033<b> |
1186 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1222 | URxvt.keysym.Meta-Control-0x63: string:\033<c> |
1187 | |
1223 | |
|
|
1224 | =item command:STRING |
|
|
1225 | |
1188 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1226 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1189 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1227 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
|
|
1228 | the opposite of C<string:> - instead of sending it to the program running |
|
|
1229 | in the terminal, it will be treated as if it were program output). This is |
|
|
1230 | most useful to feed command sequences into @@RXVT_NAME@@. |
|
|
1231 | |
1190 | example the following means "change the current locale to C<zh_CN.GBK> |
1232 | For example the following means "change the current locale to C<zh_CN.GBK> |
1191 | when Control-Meta-c is being pressed": |
1233 | when Control-Meta-c is being pressed": |
1192 | |
1234 | |
1193 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1235 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1194 | |
1236 | |
1195 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1237 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1196 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1238 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1197 | manpage. For example, the F<selection> extension (activated via |
1239 | font-switching at runtime: |
1198 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1199 | |
1240 | |
1200 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1241 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
|
|
1242 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1201 | |
1243 | |
1202 | Due the the large number of modifier combinations, a defined key mapping |
1244 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1203 | will match if at I<at least> the specified identifiers are being set, and |
1245 | info): |
1204 | no other key mappings with those and more bits are being defined. That |
|
|
1205 | means that defining a key map for C<a> will automatically provide |
|
|
1206 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1207 | mappings themselves. |
|
|
1208 | |
1246 | |
1209 | Unfortunately, this will override built-in key mappings. For example |
1247 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
1248 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1249 | |
|
|
1250 | =item builtin: |
|
|
1251 | |
|
|
1252 | The builtin action is the action that @@RXVT_NAME@@ would execute if no |
|
|
1253 | key binding existed for the key combination. The obvious use is to undo |
|
|
1254 | the effect of existing bindings. The not so obvious use is to reinstate |
|
|
1255 | bindings when another binding overrides too many modifiers. |
|
|
1256 | |
1210 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
1257 | For example if you overwrite the C<Insert> key you will disable |
1211 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
1258 | @@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke |
1212 | user-defined keymap using the C<builtin:> replacement: |
1259 | "holes" into the user-defined keymap using the C<builtin:> replacement: |
1213 | |
1260 | |
1214 | URxvt.keysym.Insert: <my insert key sequence> |
1261 | URxvt.keysym.Insert: <my insert key sequence> |
1215 | URxvt.keysym.S-Insert: builtin: |
1262 | URxvt.keysym.S-Insert: builtin: |
1216 | |
1263 | |
1217 | The first line defines a mapping for C<Insert> and I<any> combination |
1264 | The first line defines a mapping for C<Insert> and I<any> combination |
1218 | of modifiers. The second line re-establishes the default mapping for |
1265 | of modifiers. The second line re-establishes the default mapping for |
1219 | C<Shift-Insert>. |
1266 | C<Shift-Insert>. |
1220 | |
1267 | |
1221 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1268 | =item builtin-string: |
1222 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
|
|
1223 | font-switching at runtime: |
|
|
1224 | |
1269 | |
1225 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1270 | This action is mainly useful to restore string mappings for keys that |
1226 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1271 | have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit |
|
|
1272 | difficult to explain - basically, this action will send the string to the |
|
|
1273 | application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in |
|
|
1274 | action for it. |
1227 | |
1275 | |
1228 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1276 | An example might make it clearer: @@RXVT_NAME@@ normally pastes the |
1229 | info): |
1277 | selection when you press C<Shift-Insert>. With the following bindings, it |
|
|
1278 | would instead emit the (undocumented, but what applications running in the |
|
|
1279 | terminal might expect) sequence C<ESC [ 2 $> instead: |
1230 | |
1280 | |
1231 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1281 | URxvt.keysym.S-Insert: builtin-string: |
1232 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1282 | URxvt.keysym.C-S-Insert: builtin: |
|
|
1283 | |
|
|
1284 | The first line disables the paste functionality for that key |
|
|
1285 | combination, and the second reinstates the default behaviour for |
|
|
1286 | C<Control-Shift-Insert>, which would otherwise be overridden. |
|
|
1287 | |
|
|
1288 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
|
|
1289 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
|
|
1290 | this: |
|
|
1291 | |
|
|
1292 | URxvt.keysym.C-M-c: builtin-string: |
|
|
1293 | URxvt.keysym.C-M-v: builtin-string: |
|
|
1294 | |
|
|
1295 | =item EXTENSION:STRING |
|
|
1296 | |
|
|
1297 | An action of this form invokes the action B<STRING>, if any, provided |
|
|
1298 | by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will |
|
|
1299 | be loaded automatically if necessary. |
|
|
1300 | |
|
|
1301 | Not all extensions define actions, but popular extensions that do |
|
|
1302 | include the I<selection> and I<matcher> extensions (documented in their |
|
|
1303 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
|
|
1304 | respectively). |
|
|
1305 | |
|
|
1306 | From the silly examples department, this will rot13-"encrypt" |
|
|
1307 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
|
|
1308 | keyboards: |
|
|
1309 | |
|
|
1310 | URxvt.keysym.M-C-c: selection:rot13 |
|
|
1311 | |
|
|
1312 | =item perl:STRING *DEPRECATED* |
|
|
1313 | |
|
|
1314 | This is a deprecated way of invoking commands provided by perl |
|
|
1315 | extensions. It is still supported, but should not be used anymore. |
|
|
1316 | |
|
|
1317 | =back |
1233 | |
1318 | |
1234 | =item B<perl-ext-common>: I<string> |
1319 | =item B<perl-ext-common>: I<string> |
1235 | |
1320 | |
1236 | =item B<perl-ext>: I<string> |
1321 | =item B<perl-ext>: I<string> |
1237 | |
1322 | |
1238 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
1323 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
1239 | use in this terminal instance; option B<-pe>. |
1324 | use in this terminal instance; option B<-pe>. |
1240 | |
1325 | |
1241 | Extension names can be prefixed with a C<-> sign to prohibit using |
1326 | Extension names can be prefixed with a C<-> sign to remove them again, in |
1242 | them. This can be useful to selectively disable some extensions loaded |
1327 | case they had been specified earlier. This can be useful to selectively |
1243 | by default, or specified via the C<perl-ext-common> resource. For |
1328 | disable some extensions loaded by default, or specified via the |
1244 | example, C<default,-selection> will use all the default extension except |
1329 | C<perl-ext-common> resource. For example, C<default,-selection> will use |
1245 | C<selection>. |
1330 | all the default extensions except C<selection>. |
1246 | |
1331 | |
1247 | Extension names can also be followed by an argument in angle brackets |
1332 | To prohibit autoloading of extensions, you can prefix them with C</>, |
1248 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1333 | which will make urxvt refuse to automatically load them (this can be |
1249 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1334 | overridden, however, by specifying the extension name again without a |
1250 | multiple times with different arguments will pass multiple arguments to |
1335 | prefix, though). This does not prohibit extensions themselves loading |
1251 | the extension. |
1336 | other extensions. For example, C<default,/background> will keep the |
|
|
1337 | C<background> extension from being loaded when a background OSC sequence |
|
|
1338 | is received. |
|
|
1339 | |
|
|
1340 | The default set includes the C<selection>, C<option-popup>, |
|
|
1341 | C<selection-popup>, C<readline>, C<searchable-scrollback> and |
|
|
1342 | C<confirm-paste> extensions, as well as any extensions which are mentioned |
|
|
1343 | in B<keysym> resources. |
|
|
1344 | |
|
|
1345 | Any extension such that a corresponding resource is given on the |
|
|
1346 | command line is automatically appended to B<perl-ext>. |
1252 | |
1347 | |
1253 | Each extension is looked up in the library directories, loaded if |
1348 | Each extension is looked up in the library directories, loaded if |
1254 | necessary, and bound to the current terminal instance. |
1349 | necessary, and bound to the current terminal instance. When the library |
|
|
1350 | search path contains multiple extension files of the same name, then the |
|
|
1351 | first one found will be used. |
1255 | |
1352 | |
1256 | If both of these resources are the empty string, then the perl |
1353 | If both of these resources are the empty string, then the perl interpreter |
1257 | interpreter will not be initialized. The idea behind two options is that |
1354 | will not be initialized. The rationale for having two options is that |
1258 | B<perl-ext-common> will be used for extensions that should be available to |
1355 | B<perl-ext-common> will be used for extensions that should be available to |
1259 | all instances, while B<perl-ext> is used for specific instances. |
1356 | all instances, while B<perl-ext> is used for specific instances. |
1260 | |
1357 | |
1261 | =item B<perl-eval>: I<string> |
1358 | =item B<perl-eval>: I<string> |
1262 | |
1359 | |
… | |
… | |
1264 | the @@RXVT_NAME@@perl(3) manpage. |
1361 | the @@RXVT_NAME@@perl(3) manpage. |
1265 | |
1362 | |
1266 | =item B<perl-lib>: I<path> |
1363 | =item B<perl-lib>: I<path> |
1267 | |
1364 | |
1268 | Colon-separated list of additional directories that hold extension |
1365 | Colon-separated list of additional directories that hold extension |
1269 | scripts. When looking for extensions specified by the C<perl> resource, |
1366 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
1270 | @@RXVT_NAME@@ will first look in these directories and then in |
1367 | in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
1271 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1368 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1272 | |
1369 | |
1273 | See the @@RXVT_NAME@@perl(3) manpage. |
1370 | See the @@RXVT_NAME@@perl(3) manpage. |
1274 | |
1371 | |
1275 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1372 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1276 | |
1373 | |
… | |
… | |
1280 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1377 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1281 | |
1378 | |
1282 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1379 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1283 | for details. |
1380 | for details. |
1284 | |
1381 | |
1285 | =item B<searchable-scrollback:> I<keysym> |
1382 | =item B<searchable-scrollback:> I<keysym> *DEPRECATED* |
1286 | |
1383 | |
1287 | Sets the hotkey that starts the incremental scrollback buffer search |
1384 | This resource is deprecated and will be removed. Use a B<keysym> resource |
1288 | (default: C<M-s>). |
1385 | instead, e.g.: |
1289 | |
1386 | |
|
|
1387 | URxvt.keysym.M-s: searchable-scrollback:start |
|
|
1388 | |
1290 | =item B<urlLauncher>: I<string> |
1389 | =item B<url-launcher>: I<string> |
1291 | |
1390 | |
1292 | Specifies the program to be started with a URL argument. Used by the |
1391 | Specifies the program to be started with a URL argument. Used by the |
1293 | C<selection-popup> and C<matcher> perl extensions. |
1392 | C<selection-popup> and C<matcher> perl extensions. |
1294 | |
1393 | |
1295 | =item B<transient-for>: I<windowid> |
1394 | =item B<transient-for>: I<windowid> |
… | |
… | |
1339 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1438 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1340 | |
1439 | |
1341 | The behaviour of text selection and insertion/pasting mechanism is similar |
1440 | The behaviour of text selection and insertion/pasting mechanism is similar |
1342 | to I<xterm>(1). |
1441 | to I<xterm>(1). |
1343 | |
1442 | |
1344 | =over 4 |
1443 | =over |
1345 | |
1444 | |
1346 | =item B<Selecting>: |
1445 | =item B<Selecting>: |
1347 | |
1446 | |
1348 | Left click at the beginning of the region, drag to the end of the region |
1447 | Left click at the beginning of the region, drag to the end of the region |
1349 | and release; Right click to extend the marked region; Left double-click |
1448 | and release; Right click to extend the marked region; Left double-click |
… | |
… | |
1364 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1463 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1365 | |
1464 | |
1366 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1465 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1367 | inserted too. |
1466 | inserted too. |
1368 | |
1467 | |
|
|
1468 | rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and |
|
|
1469 | <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first |
|
|
1470 | binding causes the value of the internal selection to be copied to the |
|
|
1471 | CLIPBOARD selection, while the second binding causes the value of the |
|
|
1472 | CLIPBOARD selection to be inserted. |
|
|
1473 | |
1369 | =back |
1474 | =back |
1370 | |
1475 | |
1371 | =head1 CHANGING FONTS |
1476 | =head1 CHANGING FONTS |
1372 | |
1477 | |
1373 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1478 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
… | |
… | |
1390 | and character codes using the keyboard. It consists of 4 parts. The |
1495 | and character codes using the keyboard. It consists of 4 parts. The |
1391 | first part is available if rxvt-unicode has been compiled with |
1496 | first part is available if rxvt-unicode has been compiled with |
1392 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1497 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1393 | with C<--enable-iso14755>. |
1498 | with C<--enable-iso14755>. |
1394 | |
1499 | |
1395 | =over 4 |
1500 | =over |
1396 | |
1501 | |
1397 | =item * 5.1: Basic method |
1502 | =item * 5.1: Basic method |
1398 | |
1503 | |
1399 | This allows you to enter unicode characters using their hexcode. |
1504 | This allows you to enter unicode characters using their hexcode. |
1400 | |
1505 | |
… | |
… | |
1461 | In addition to the default foreground and background colours, |
1566 | In addition to the default foreground and background colours, |
1462 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1567 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1463 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1568 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1464 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
1569 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
1465 | cube plus a 8 (24) colour greyscale ramp. |
1570 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1571 | |
|
|
1572 | B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes |
|
|
1573 | C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the |
|
|
1574 | number of 24-bit colours that can be used is limited: an internal 7x7x5 (256 |
|
|
1575 | colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the |
|
|
1576 | 24-bit colour space. When indexing collisions happen, the nearest old colour in |
|
|
1577 | the cube will be adapted to the new 24-bit RGB colour. That means one cannot |
|
|
1578 | use many similar 24-bit colours. It's typically not a problem in common |
|
|
1579 | scenarios. |
1466 | |
1580 | |
1467 | Here is a list of the ANSI colours with their names. |
1581 | Here is a list of the ANSI colours with their names. |
1468 | |
1582 | |
1469 | =begin table |
1583 | =begin table |
1470 | |
1584 | |
… | |
… | |
1497 | The following text gives values for the standard 88 colour mode (and |
1611 | The following text gives values for the standard 88 colour mode (and |
1498 | values for the 256 colour mode in parentheses). |
1612 | values for the 256 colour mode in parentheses). |
1499 | |
1613 | |
1500 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
1614 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
1501 | |
1615 | |
1502 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
1616 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
1503 | index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 |
1617 | index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5 |
1504 | |
1618 | |
1505 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
1619 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
1506 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
1620 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
1507 | the RGB cube. |
1621 | the RGB cube. |
1508 | |
1622 | |
… | |
… | |
1524 | White. |
1638 | White. |
1525 | |
1639 | |
1526 | =head2 ALPHA CHANNEL SUPPORT |
1640 | =head2 ALPHA CHANNEL SUPPORT |
1527 | |
1641 | |
1528 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1642 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1529 | their act together, rxvt-unicode will do it's own alpha channel management: |
1643 | their act together, rxvt-unicode will do its own alpha channel management: |
1530 | |
1644 | |
1531 | You can prefix any colour with an opaqueness percentage enclosed in |
1645 | You can prefix any colour with an opaqueness percentage enclosed in |
1532 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1646 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1533 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1647 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1534 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1648 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
… | |
… | |
1571 | |
1685 | |
1572 | =head1 ENVIRONMENT |
1686 | =head1 ENVIRONMENT |
1573 | |
1687 | |
1574 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1688 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1575 | |
1689 | |
1576 | =over 4 |
1690 | =over |
1577 | |
1691 | |
1578 | =item B<TERM> |
1692 | =item B<TERM> |
1579 | |
1693 | |
1580 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1694 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1581 | resources or on the command line. |
1695 | resources or on the command line. |
… | |
… | |
1616 | |
1730 | |
1617 | =item B<SHELL> |
1731 | =item B<SHELL> |
1618 | |
1732 | |
1619 | The shell to be used for command execution, defaults to C</bin/sh>. |
1733 | The shell to be used for command execution, defaults to C</bin/sh>. |
1620 | |
1734 | |
1621 | =item B<RXVT_SOCKET> |
1735 | =item B<RXVT_SOCKET> [I<sic>] |
1622 | |
1736 | |
1623 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1737 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1624 | @@RXVT_NAME@@d(1). |
1738 | @@RXVT_NAME@@d(1). |
1625 | |
1739 | |
1626 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1740 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1741 | |
|
|
1742 | =item B<URXVT_PERL_LIB> |
|
|
1743 | |
|
|
1744 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1745 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1746 | directory. |
|
|
1747 | |
|
|
1748 | =item B<URXVT_PERL_VERBOSITY> |
|
|
1749 | |
|
|
1750 | See L<@@RXVT_NAME@@perl>(3). |
1627 | |
1751 | |
1628 | =item B<HOME> |
1752 | =item B<HOME> |
1629 | |
1753 | |
1630 | Used to locate the default directory for the unix domain socket for |
1754 | Used to locate the default directory for the unix domain socket for |
1631 | daemon communications and to locate various resource files (such as |
1755 | daemon communications and to locate various resource files (such as |
1632 | C<.Xdefaults>) |
1756 | C<.Xdefaults>) |
1633 | |
1757 | |
1634 | =item B<XAPPLRESDIR> |
1758 | =item B<XAPPLRESDIR> |
1635 | |
1759 | |
1636 | Directory where various X resource files are being located. |
1760 | Directory where application-specific X resource files are located. |
1637 | |
1761 | |
1638 | =item B<XENVIRONMENT> |
1762 | =item B<XENVIRONMENT> |
1639 | |
1763 | |
1640 | If set and accessible, gives the name of a X resource file to be loaded by |
1764 | If set and accessible, gives the name of a X resource file to be loaded by |
1641 | @@RXVT_NAME@@. |
1765 | @@RXVT_NAME@@. |
1642 | |
1766 | |
1643 | =back |
1767 | =back |
1644 | |
1768 | |
1645 | =head1 FILES |
1769 | =head1 FILES |
1646 | |
1770 | |
1647 | =over 4 |
1771 | =over |
1648 | |
1772 | |
1649 | =item B</usr/lib/X11/rgb.txt> |
1773 | =item B</usr/lib/X11/rgb.txt> |
1650 | |
1774 | |
1651 | Colour names. |
1775 | Colour names. |
1652 | |
1776 | |
1653 | =back |
1777 | =back |
1654 | |
1778 | |
1655 | =head1 SEE ALSO |
1779 | =head1 SEE ALSO |
1656 | |
1780 | |
|
|
1781 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1657 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1782 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1658 | |
1783 | |
1659 | =head1 CURRENT PROJECT COORDINATOR |
1784 | =head1 CURRENT PROJECT COORDINATOR |
1660 | |
1785 | |
1661 | =over 4 |
1786 | =over |
1662 | |
1787 | |
1663 | =item Project Coordinator |
1788 | =item Project Coordinator |
1664 | |
1789 | |
1665 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1790 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1666 | |
1791 | |
1667 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1792 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1668 | |
1793 | |
1669 | =back |
1794 | =back |
1670 | |
1795 | |
1671 | =head1 AUTHORS |
1796 | =head1 AUTHORS |
1672 | |
1797 | |
1673 | =over 4 |
1798 | =over |
1674 | |
1799 | |
1675 | =item John Bovey |
1800 | =item John Bovey |
1676 | |
1801 | |
1677 | University of Kent, 1992, wrote the original Xvt. |
1802 | University of Kent, 1992, wrote the original Xvt. |
1678 | |
1803 | |
1679 | =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1804 | =item Rob Nation <nation@rocket.sanders.lockheed.com> |
1680 | |
1805 | |
1681 | very heavily modified Xvt and came up with Rxvt |
1806 | very heavily modified Xvt and came up with Rxvt |
1682 | |
1807 | |
1683 | =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1808 | =item Angelo Haritsis <ah@doc.ic.ac.uk> |
1684 | |
1809 | |
1685 | wrote the Greek Keyboard Input (no longer in code) |
1810 | wrote the Greek Keyboard Input (no longer in code) |
1686 | |
1811 | |
1687 | =item mj olesen L<< <olesen@me.QueensU.CA> >> |
1812 | =item mj olesen <olesen@me.QueensU.CA> |
1688 | |
1813 | |
1689 | Wrote the menu system. |
1814 | Wrote the menu system. |
1690 | |
1815 | |
1691 | Project Coordinator (changes.txt 2.11 to 2.21) |
1816 | Project Coordinator (changes.txt 2.11 to 2.21) |
1692 | |
1817 | |
1693 | =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1818 | =item Oezguer Kesim <kesim@math.fu-berlin.de> |
1694 | |
1819 | |
1695 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1820 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1696 | |
1821 | |
1697 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1822 | =item Geoff Wing <gcw@pobox.com> |
1698 | |
1823 | |
1699 | Rewrote screen display and text selection routines. |
1824 | Rewrote screen display and text selection routines. |
1700 | |
1825 | |
1701 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1826 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1702 | |
1827 | |
1703 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1828 | =item Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1704 | |
1829 | |
1705 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1830 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1706 | extension, random hacks, numerous bugfixes and extensions. |
1831 | extension, random hacks, numerous bugfixes and extensions. |
1707 | |
1832 | |
1708 | Project Coordinator (Changes 1.0 -) |
1833 | Project Coordinator (Changes 1.0 -) |
1709 | |
1834 | |
1710 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1835 | =item Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
1711 | |
1836 | |
1712 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1837 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
1713 | |
1838 | |
1714 | =back |
1839 | =back |
1715 | |
1840 | |