… | |
… | |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 | a significant advantage on a machine serving many X sessions. |
15 | a significant advantage on a machine serving many X sessions. |
16 | |
16 | |
|
|
17 | This document is also available on the World-Wide-Web at |
|
|
18 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>. |
|
|
19 | |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
20 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
21 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
22 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 | frequently asked questions and answer to them and some common |
23 | frequently asked questions and answer to them and some common |
21 | problems. That document is also accessible on the World-Wide-Web at |
24 | problems. That document is also accessible on the World-Wide-Web at |
22 | L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. |
25 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>. |
23 | |
26 | |
24 | =head1 RXVT-UNICODE VS. RXVT |
27 | =head1 RXVT-UNICODE VS. RXVT |
25 | |
28 | |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
29 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
27 | internally. That means it can store and display most scripts in the |
30 | internally. That means it can store and display most scripts in the |
28 | world. Being a terminal emulator, however, some things are very difficult, |
31 | world. Being a terminal emulator, however, some things are very difficult, |
29 | especially cursive scripts such as arabic, vertically written scripts |
32 | especially cursive scripts such as arabic, vertically written scripts |
30 | like mongolian or scripts requiring extremely complex combining rules, |
33 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devenagari. Don't expect pretty output when using these |
34 | like tibetan or devanagari. Don't expect pretty output when using these |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
35 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 | fine, though. A somewhat difficult case are right-to-left scripts, such |
36 | fine, though. A somewhat difficult case are right-to-left scripts, such |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
37 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
35 | belong into the application, not the terminal emulator (too many things -- |
38 | belong in the application, not the terminal emulator (too many things -- |
36 | such as cursor-movement while editing -- break otherwise), but that might |
39 | such as cursor-movement while editing -- break otherwise), but that might |
37 | change. |
40 | change. |
38 | |
41 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
42 | If you are looking for a terminal that supports more exotic scripts, let |
40 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
43 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
… | |
… | |
114 | |
117 | |
115 | =item B<-ss>|B<+ss> |
118 | =item B<-ss>|B<+ss> |
116 | |
119 | |
117 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
120 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
118 | |
121 | |
119 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
122 | =item B<-tr>|B<+tr> |
120 | |
123 | |
121 | Turn on/off inheriting parent window's pixmap. Alternative form is |
124 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
122 | B<-tr>; resource B<inheritPixmap>. |
|
|
123 | |
125 | |
124 | I<Please note that transparency of any kind if completely unsupported by |
126 | B<-ip> is still accepted as an obsolete alias but will be removed in |
125 | the author. Don't bug him with installation questions! Read the FAQ (man 7 |
127 | future versions. |
126 | @@RXVT_NAME@@)!> |
128 | |
|
|
129 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
130 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
127 | |
131 | |
128 | =item B<-fade> I<number> |
132 | =item B<-fade> I<number> |
129 | |
133 | |
130 | Fade the text by the given percentage when focus is lost. Small values |
134 | Fade the text by the given percentage when focus is lost. Small values |
131 | fade a little only, 100 completely replaces all colours by the fade |
135 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
137 | is opaque black. resource B<fadeColor>. |
141 | is opaque black. resource B<fadeColor>. |
138 | |
142 | |
139 | =item B<-tint> I<colour> |
143 | =item B<-tint> I<colour> |
140 | |
144 | |
141 | Tint the transparent background pixmap with the given colour when |
145 | Tint the transparent background pixmap with the given colour when |
142 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
146 | transparency is enabled with B<-tr>. This only works for |
143 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
147 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
144 | used to brighten or darken the image in addition to tinting it; resource |
148 | used to brighten or darken the image in addition to tinting it. |
|
|
149 | Please note that certain tint colours can be applied on the server-side, |
|
|
150 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
151 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
152 | pure black and pure white colors essentially mean no tinting; resource |
145 | I<tintColor>. Example: |
153 | I<tintColor>. Example: |
146 | |
154 | |
147 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
155 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
148 | |
156 | |
149 | =item B<-sh> I<number> |
157 | =item B<-sh> I<number> |
150 | |
158 | |
151 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
159 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
152 | background image in addition to (or instead of) tinting it; |
160 | background image in addition to (or instead of) tinting it; |
153 | resource I<shading>. |
161 | resource I<shading>. |
154 | |
162 | |
155 | =item B<-blt> I<string> |
163 | =item B<-blt> I<string> |
156 | |
164 | |
157 | Specify background blending type. If background pixmap is specified |
165 | Specify background blending type. If background pixmap is specified |
158 | at the same time as transparency - such pixmap will be blended over |
166 | at the same time as transparency - such pixmap will be blended over |
159 | transparency image, using method specified. Supported values are : |
167 | transparency image, using method specified. Supported values are : |
160 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
168 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
161 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
169 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
162 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
170 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
163 | alpha-blending; resource I<blendType>. |
171 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
164 | |
172 | |
165 | =item B<-blr> I<number> |
173 | =item B<-blr> I<HxV> |
166 | |
174 | |
167 | Apply Gaussian Blur with the specified radius to the transparent |
175 | Apply Gaussian Blur with the specified radii to the transparent |
168 | background image; resource I<blurRadius>. |
176 | background image. If single number is specified - both vertical and |
|
|
177 | horizontal radii are considered to be the same. Setting one of the |
|
|
178 | radii to 1 and another to a large number creates interesting effects |
|
|
179 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
|
|
180 | resource I<blurRadius>. |
169 | |
181 | |
170 | =item B<-bg> I<colour> |
182 | =item B<-bg> I<colour> |
171 | |
183 | |
172 | Window background colour; resource B<background>. |
184 | Window background colour; resource B<background>. |
173 | |
185 | |
174 | =item B<-fg> I<colour> |
186 | =item B<-fg> I<colour> |
175 | |
187 | |
176 | Window foreground colour; resource B<foreground>. |
188 | Window foreground colour; resource B<foreground>. |
177 | |
189 | |
178 | =item B<-pixmap> I<file[;geom]> |
190 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
179 | |
191 | |
180 | Compile I<afterimage>: Specify image file for the background and also |
192 | Compile I<afterimage>: Specify image file for the background and also |
181 | optionally specify its scaling with a geometry string. Note you may need to |
193 | optionally specify its scaling with a geometry string. Note you may need to |
182 | add quotes to avoid special shell interpretation of the C<;> in the |
194 | add quotes to avoid special shell interpretation of the C<;> in the |
183 | command-line; for more details see resource B<backgroundPixmap>. |
195 | command-line; for more details see resource B<backgroundPixmap>. |
184 | |
196 | |
185 | =item B<-cr> I<colour> |
197 | =item B<-cr> I<colour> |
… | |
… | |
233 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
245 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
234 | for details. |
246 | for details. |
235 | |
247 | |
236 | =item B<-is>|B<+is> |
248 | =item B<-is>|B<+is> |
237 | |
249 | |
238 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
250 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
239 | foreground/background (default). See resource B<intensityStyles> for |
251 | foreground/background (default). See resource B<intensityStyles> for |
240 | details. |
252 | details. |
241 | |
253 | |
242 | =item B<-name> I<name> |
254 | =item B<-name> I<name> |
243 | |
255 | |
… | |
… | |
261 | |
273 | |
262 | =item B<-sb>|B<+sb> |
274 | =item B<-sb>|B<+sb> |
263 | |
275 | |
264 | Turn on/off scrollbar; resource B<scrollBar>. |
276 | Turn on/off scrollbar; resource B<scrollBar>. |
265 | |
277 | |
|
|
278 | =item B<-sr>|B<+sr> |
|
|
279 | |
|
|
280 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
281 | |
|
|
282 | =item B<-st>|B<+st> |
|
|
283 | |
|
|
284 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
285 | resource B<scrollBar_floating>. |
|
|
286 | |
266 | =item B<-si>|B<+si> |
287 | =item B<-si>|B<+si> |
267 | |
288 | |
268 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
289 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
269 | B<scrollTtyOutput> has opposite effect. |
290 | B<scrollTtyOutput> has opposite effect. |
270 | |
291 | |
… | |
… | |
276 | =item B<-sw>|B<+sw> |
297 | =item B<-sw>|B<+sw> |
277 | |
298 | |
278 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
299 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
279 | This only takes effect if B<-si> is also given; resource |
300 | This only takes effect if B<-si> is also given; resource |
280 | B<scrollWithBuffer>. |
301 | B<scrollWithBuffer>. |
281 | |
|
|
282 | =item B<-sr>|B<+sr> |
|
|
283 | |
|
|
284 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
285 | |
|
|
286 | =item B<-st>|B<+st> |
|
|
287 | |
|
|
288 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
289 | resource B<scrollBar_floating>. |
|
|
290 | |
302 | |
291 | =item B<-ptab>|B<+ptab> |
303 | =item B<-ptab>|B<+ptab> |
292 | |
304 | |
293 | If enabled (default), "Horizontal Tab" characters are being stored as |
305 | If enabled (default), "Horizontal Tab" characters are being stored as |
294 | actual wide characters in the screen buffer, which makes it possible to |
306 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
341 | |
353 | |
342 | =item B<-lsp> I<number> |
354 | =item B<-lsp> I<number> |
343 | |
355 | |
344 | Compile I<frills>: Lines (pixel height) to insert between each row of |
356 | Compile I<frills>: Lines (pixel height) to insert between each row of |
345 | the display. Useful to work around font rendering problems; resource |
357 | the display. Useful to work around font rendering problems; resource |
346 | B<linespace>. |
358 | B<lineSpace>. |
347 | |
359 | |
348 | =item B<-tn> I<termname> |
360 | =item B<-tn> I<termname> |
349 | |
361 | |
350 | This option specifies the name of the terminal type to be set in the |
362 | This option specifies the name of the terminal type to be set in the |
351 | B<TERM> environment variable. This terminal type must exist in the |
363 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
406 | |
418 | |
407 | =item B<-tcw> |
419 | =item B<-tcw> |
408 | |
420 | |
409 | Change the meaning of triple-click selection with the left mouse |
421 | Change the meaning of triple-click selection with the left mouse |
410 | button. Only effective when the original (non-perl) selection code is |
422 | button. Only effective when the original (non-perl) selection code is |
411 | in-use. Instead of selecting a full line it will extend the selection the |
423 | in-use. Instead of selecting a full line it will extend the selection to |
412 | end of the logical line only. resource B<tripleclickwords>. |
424 | the end of the logical line only. resource B<tripleclickwords>. |
413 | |
425 | |
414 | =item B<-insecure> |
426 | =item B<-insecure> |
415 | |
427 | |
416 | Enable "insecure" mode, which currently enables most of the escape |
428 | Enable "insecure" mode, which currently enables most of the escape |
417 | sequences that echo strings. See the resource B<insecure> for more |
429 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
437 | |
449 | |
438 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
450 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
439 | will not immediately destroy its window when the program executed within |
451 | will not immediately destroy its window when the program executed within |
440 | it exits. Instead, it will wait till it is being killed or closed by the |
452 | it exits. Instead, it will wait till it is being killed or closed by the |
441 | user; resource B<hold>. |
453 | user; resource B<hold>. |
|
|
454 | |
|
|
455 | =item B<-xrm> I<string> |
|
|
456 | |
|
|
457 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
458 | as if it were specified in a resource file. Resource values specified this |
|
|
459 | way take precedence over all other resource specifications. |
|
|
460 | |
|
|
461 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
462 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
463 | options can be specified as long-options on the commandline, so use |
|
|
464 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
465 | resources (e.g. for input methods) or for compatibility with other |
|
|
466 | programs. |
442 | |
467 | |
443 | =item B<-keysym.>I<sym> I<string> |
468 | =item B<-keysym.>I<sym> I<string> |
444 | |
469 | |
445 | Remap a key symbol. See resource B<keysym>. |
470 | Remap a key symbol. See resource B<keysym>. |
446 | |
471 | |
… | |
… | |
481 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
506 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
482 | entries and will not tinker with pty/tty permissions - you have to do that |
507 | entries and will not tinker with pty/tty permissions - you have to do that |
483 | yourself if you want that. |
508 | yourself if you want that. |
484 | |
509 | |
485 | As an extremely special case, specifying C<-1> will completely suppress |
510 | As an extremely special case, specifying C<-1> will completely suppress |
486 | pty/tty operations. |
511 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
512 | perl extension that manages the terminal. |
487 | |
513 | |
488 | Here is a example in perl that illustrates how this option can be used (a |
514 | Here is a example in perl that illustrates how this option can be used (a |
489 | longer example is in F<doc/pty-fd>): |
515 | longer example is in F<doc/pty-fd>): |
490 | |
516 | |
491 | use IO::Pty; |
517 | use IO::Pty; |
… | |
… | |
505 | Comma-separated list of perl extension scripts to use (or not to use) in |
531 | Comma-separated list of perl extension scripts to use (or not to use) in |
506 | this terminal instance. See resource B<perl-ext> for details. |
532 | this terminal instance. See resource B<perl-ext> for details. |
507 | |
533 | |
508 | =back |
534 | =back |
509 | |
535 | |
510 | =head1 RESOURCES (available also as long-options) |
536 | =head1 RESOURCES |
511 | |
537 | |
512 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
538 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
513 | options) compiled into your version. |
539 | options) compiled into your version. All resources are also available as |
|
|
540 | long-options. |
514 | |
541 | |
515 | You can set and change the resources using X11 tools like B<xrdb>. Many |
542 | You can set and change the resources using X11 tools like B<xrdb>. Many |
516 | distribution do also load settings from the B<~/.Xresources> file when X |
543 | distribution do also load settings from the B<~/.Xresources> file when X |
517 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
544 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
518 | with later settings overwriting earlier ones: |
545 | with later settings overwriting earlier ones: |
… | |
… | |
520 | 1. system-wide app-defaults file, either locale-dependent OR global |
547 | 1. system-wide app-defaults file, either locale-dependent OR global |
521 | 2. app-defaults file in $XAPPLRESDIR |
548 | 2. app-defaults file in $XAPPLRESDIR |
522 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
549 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
523 | 4. SCREEN_RESOURCES for the current screen |
550 | 4. SCREEN_RESOURCES for the current screen |
524 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
551 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
552 | 6. resources specified via -xrm on the commandline |
525 | |
553 | |
526 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
554 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
527 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
555 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
528 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
556 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
529 | configured, while the class name B<URxvt> allows resources unique to |
557 | configured, while the class name B<URxvt> allows resources unique to |
… | |
… | |
631 | |
659 | |
632 | B<False>: specify that everything is to be displayed, even |
660 | B<False>: specify that everything is to be displayed, even |
633 | if the refresh is too fast for the human eye to read anything (or the |
661 | if the refresh is too fast for the human eye to read anything (or the |
634 | monitor to display anything); option B<+ss>. |
662 | monitor to display anything); option B<+ss>. |
635 | |
663 | |
636 | =item B<inheritPixmap:> I<boolean> |
664 | =item B<transparent:> I<boolean> |
637 | |
665 | |
638 | B<True>: make the background inherit the parent windows' pixmap, giving |
666 | Turn on/off illusion of a transparent window background. |
639 | artificial transparency. B<False>: do not inherit the parent windows' |
|
|
640 | pixmap. |
|
|
641 | |
667 | |
642 | I<Please note that transparency of any kind if completely unsupported by |
668 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
643 | the author. Don't bug him with installation questions!> |
669 | future versions. |
|
|
670 | |
|
|
671 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
672 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
644 | |
673 | |
645 | =item B<fading:> I<number> |
674 | =item B<fading:> I<number> |
646 | |
675 | |
647 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
676 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
648 | |
677 | |
… | |
… | |
665 | |
694 | |
666 | Specify background blending type; option B<-blt>. |
695 | Specify background blending type; option B<-blt>. |
667 | |
696 | |
668 | =item B<blurRadius:> I<number> |
697 | =item B<blurRadius:> I<number> |
669 | |
698 | |
670 | Apply Gaussian Blurr with the specified radius to the transparent |
699 | Apply Gaussian Blurr with the specified radius to the transparent |
671 | background image; option B<-blr>. |
700 | background image; option B<-blr>. |
672 | |
701 | |
673 | =item B<scrollColor:> I<colour> |
702 | =item B<scrollColor:> I<colour> |
674 | |
703 | |
675 | Use the specified colour for the scrollbar [default #B2B2B2]. |
704 | Use the specified colour for the scrollbar [default #B2B2B2]. |
… | |
… | |
682 | =item B<borderColor:> I<colour> |
711 | =item B<borderColor:> I<colour> |
683 | |
712 | |
684 | The colour of the border around the text area and between the scrollbar |
713 | The colour of the border around the text area and between the scrollbar |
685 | and the text. |
714 | and the text. |
686 | |
715 | |
687 | =item B<backgroundPixmap:> I<file[;geom]> |
716 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
688 | |
717 | |
689 | Use the specified image file for the background and also optionally |
718 | Use the specified image file for the background and also |
690 | specify its scaling with a geometry string B<WxH+X+Y>, |
719 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
691 | in which B<"W" / "H"> specify the horizontal/vertical scale (percent), |
720 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
692 | and B<"X" / "Y"> locate the image centre (percent). |
721 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
693 | A scale of 0 displays the image with tiling. A scale of 1 displays the |
722 | centre (percent). A scale of 0 displays the image with tiling. A scale |
694 | image without any scaling. A scale of 2 to 9 specifies an integer |
723 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
695 | number of images in that direction. No image will be magnified beyond |
724 | an integer number of images in that direction. No image will be magnified |
696 | 10 times its original size. The maximum permitted scale is 1000. |
725 | beyond 10 times its original size. The maximum permitted scale is 1000. |
697 | Special string of B<"auto"> used as a geometry will cause image to be |
726 | Additional operations can be specified after colon B<:op1:op2...>. |
698 | automatically scaled to match window size. |
727 | Supported operations are: |
|
|
728 | |
|
|
729 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
730 | propscale will scale image keeping proportions |
|
|
731 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
732 | hscale will scale image horizontally to the window size |
|
|
733 | vscale will scale image vertically to the window size |
|
|
734 | scale will scale image to match window size |
|
|
735 | root will tile image as if it was a root window background, auto-adjusting |
|
|
736 | whenever terminal window moves |
|
|
737 | |
699 | If used in conjunction with B<-tr> option - specified pixmap will be |
738 | If used in conjunction with B<-tr> option, the specified pixmap will be |
700 | blended over transparency image using either alpha-blending, or any |
739 | blended over transparency image using either alpha-blending, or any |
701 | other blending type, specified with B<-blt "type"> option. |
740 | other blending type, specified with B<-blt "type"> option. |
702 | [default 0x0+50+50] |
|
|
703 | |
741 | |
704 | =item B<path:> I<path> |
742 | =item B<path:> I<path> |
705 | |
743 | |
706 | Specify the colon-delimited search path for finding XPM files. |
744 | Specify the colon-delimited search path for finding background image files. |
707 | |
745 | |
708 | =item B<font:> I<fontlist> |
746 | =item B<font:> I<fontlist> |
709 | |
747 | |
710 | 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 |
711 | 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 |
… | |
… | |
768 | text font will being used for the given style. |
806 | text font will being used for the given style. |
769 | |
807 | |
770 | =item B<intensityStyles:> I<boolean> |
808 | =item B<intensityStyles:> I<boolean> |
771 | |
809 | |
772 | When font styles are not enabled, or this option is enabled (B<True>, |
810 | When font styles are not enabled, or this option is enabled (B<True>, |
773 | option B<-is>, the default), bold and italic font styles imply high |
811 | option B<-is>, the default), bold/blink font styles imply high |
774 | intensity foreground/background colours. Disabling this option (B<False>, |
812 | intensity foreground/background colours. Disabling this option (B<False>, |
775 | option B<+is>) disables this behaviour, the high intensity colours are not |
813 | option B<+is>) disables this behaviour, the high intensity colours are not |
776 | reachable. |
814 | reachable. |
777 | |
815 | |
778 | =item B<selectstyle:> I<mode> |
|
|
779 | |
|
|
780 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
|
|
781 | is xterm style with 2.20 old word selection, or anything else which |
|
|
782 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
783 | selection code is in use. |
|
|
784 | |
|
|
785 | =item B<scrollstyle:> I<mode> |
|
|
786 | |
|
|
787 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
788 | the author's favourite. |
|
|
789 | |
|
|
790 | =item B<title:> I<string> |
816 | =item B<title:> I<string> |
791 | |
817 | |
792 | Set window title string, the default title is the command-line |
818 | Set window title string, the default title is the command-line |
793 | specified after the B<-e> option, if any, otherwise the application |
819 | specified after the B<-e> option, if any, otherwise the application |
794 | name; option B<-title>. |
820 | name; option B<-title>. |
… | |
… | |
838 | |
864 | |
839 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
865 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
840 | |
866 | |
841 | This creates a new file in your home directory with the screen contents |
867 | This creates a new file in your home directory with the screen contents |
842 | every time you hit C<Print>. |
868 | every time you hit C<Print>. |
|
|
869 | |
|
|
870 | =item B<scrollstyle:> I<mode> |
|
|
871 | |
|
|
872 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
873 | the author's favourite. |
843 | |
874 | |
844 | =item B<scrollBar:> I<boolean> |
875 | =item B<scrollBar:> I<boolean> |
845 | |
876 | |
846 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
877 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
847 | disable the scrollbar; option B<+sb>. |
878 | disable the scrollbar; option B<+sb>. |
… | |
… | |
910 | =item B<termName:> I<termname> |
941 | =item B<termName:> I<termname> |
911 | |
942 | |
912 | Specifies the terminal type name to be set in the B<TERM> environment |
943 | Specifies the terminal type name to be set in the B<TERM> environment |
913 | variable; option B<-tn>. |
944 | variable; option B<-tn>. |
914 | |
945 | |
915 | =item B<linespace:> I<number> |
946 | =item B<lineSpace:> I<number> |
916 | |
947 | |
917 | Specifies number of lines (pixel height) to insert between each row of |
948 | Specifies number of lines (pixel height) to insert between each row of |
918 | the display [default 0]; option B<-lsp>. |
949 | the display [default 0]; option B<-lsp>. |
919 | |
950 | |
920 | =item B<meta8:> I<boolean> |
951 | =item B<meta8:> I<boolean> |
… | |
… | |
980 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
1011 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
981 | |
1012 | |
982 | When the selection extension is not used, only ISO-8859-1 characters can |
1013 | When the selection extension is not used, only ISO-8859-1 characters can |
983 | be used. If not specified, the built-in default is used: |
1014 | be used. If not specified, the built-in default is used: |
984 | |
1015 | |
985 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
1016 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
986 | |
1017 | |
987 | =item B<preeditType:> I<style> |
1018 | =item B<preeditType:> I<style> |
988 | |
1019 | |
989 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1020 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
990 | |
1021 | |
… | |
… | |
1078 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1109 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1079 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1110 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1080 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1111 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1081 | performed in an exact manner; however, the closest match is assured. |
1112 | performed in an exact manner; however, the closest match is assured. |
1082 | |
1113 | |
1083 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1114 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1084 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1115 | number), see RESOURCES in C<man 7 X> for futher details. |
1085 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
|
|
1086 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
|
|
1087 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1088 | be removed>. |
|
|
1089 | |
|
|
1090 | Please note that you need to double the C<\> in resource files, as |
|
|
1091 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
|
|
1092 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
|
|
1093 | processing). |
|
|
1094 | |
1116 | |
1095 | You can define a range of keysyms in one shot by providing a I<string> |
1117 | You can define a range of keysyms in one shot by providing a I<string> |
1096 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1118 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1097 | should be a character not used by the strings. |
1119 | should be a character not used by the strings. |
1098 | |
1120 | |
… | |
… | |
1305 | |
1327 | |
1306 | =head1 ISO 14755 SUPPORT |
1328 | =head1 ISO 14755 SUPPORT |
1307 | |
1329 | |
1308 | ISO 14755 is a standard for entering and viewing unicode characters |
1330 | ISO 14755 is a standard for entering and viewing unicode characters |
1309 | and character codes using the keyboard. It consists of 4 parts. The |
1331 | and character codes using the keyboard. It consists of 4 parts. The |
1310 | first part is available rxvt-unicode has been compiled with |
1332 | first part is available if rxvt-unicode has been compiled with |
1311 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1333 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1312 | with C<--enable-iso14755>. |
1334 | with C<--enable-iso14755>. |
1313 | |
1335 | |
1314 | =over 4 |
1336 | =over 4 |
1315 | |
1337 | |
… | |
… | |
1431 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1453 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1432 | on White. |
1454 | on White. |
1433 | |
1455 | |
1434 | =back |
1456 | =back |
1435 | |
1457 | |
1436 | =head2 ALPHA CHANNEL SUPPORT |
1458 | =head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS |
1437 | |
1459 | |
1438 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1460 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1439 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1461 | their act together, rxvt-unicode will do it's own alpha channel management: |
1440 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1462 | |
1441 | in addition to the ones provided by X, where the additional A component |
1463 | You can prefix any color with an opaquenes percentage enclosed in |
|
|
1464 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1465 | (0-100) that specifies the opacity of the color, where C<0> is completely |
|
|
1466 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1467 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1468 | is the recommended format to specify transparency values, and works with |
|
|
1469 | all ways to specify a colour. |
|
|
1470 | |
|
|
1471 | For complete control, rxvt-unicode also supports |
|
|
1472 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1473 | specifications, where the additional C<aaaa> component specifies opacity |
1442 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1474 | (alpha) values. The minimum value of C<0000> is completely transparent, |
1443 | transparent). You can also prefix any color with C<[percent]>, where |
1475 | while C<ffff> is completely opaque). The two example colours from |
1444 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
1476 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
1445 | the color, where C<0> is completely transparent and C<100> is completelxy |
1477 | C<rgba:0000/ff00/0000/f332>. |
1446 | opaque. |
|
|
1447 | |
1478 | |
1448 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1479 | You probably need to specify B<"-depth 32">, too, to force a visual with |
1449 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1480 | alpha channels, and have the luck that your X-server uses ARGB pixel |
1450 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1481 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1482 | rxvt-unicode just fudges around. |
1451 | |
1483 | |
1452 | For example, the following selects an almost completely transparent red |
1484 | For example, the following selects an almost completely transparent black |
1453 | background, and an almost opaque pink foreground: |
1485 | background, and an almost opaque pink foreground: |
1454 | |
1486 | |
1455 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1487 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
1456 | |
1488 | |
1457 | I<Please note that transparency of any kind if completely unsupported by |
1489 | When not using a background image, then the interpretation of the |
1458 | the author. Don't bug him with installation questions!> |
1490 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1491 | transparency of course). |
|
|
1492 | |
|
|
1493 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1494 | colour will always behave as if it were completely transparent (so the |
|
|
1495 | background image shows instead), regardless of how it was specified, while |
|
|
1496 | other colours will either be transparent as specified (the background |
|
|
1497 | image will show through) on servers supporting the RENDER extension, or |
|
|
1498 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1499 | |
|
|
1500 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1501 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1502 | extension. |
1459 | |
1503 | |
1460 | =head1 ENVIRONMENT |
1504 | =head1 ENVIRONMENT |
1461 | |
1505 | |
1462 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1506 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1463 | |
1507 | |
… | |
… | |
1469 | resources or on the command line. |
1513 | resources or on the command line. |
1470 | |
1514 | |
1471 | =item B<COLORTERM> |
1515 | =item B<COLORTERM> |
1472 | |
1516 | |
1473 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1517 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1474 | compiled with XPM support, and optionally with the added extension |
1518 | compiled with background image support, and optionally with the added |
1475 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1519 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
|
|
1520 | screen. |
1476 | |
1521 | |
1477 | =item B<COLORFGBG> |
1522 | =item B<COLORFGBG> |
1478 | |
1523 | |
1479 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1524 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1480 | the colour code used as default foreground/text colour (or the string |
1525 | the colour code used as default foreground/text colour (or the string |
1481 | C<default> to indicate that the default-colour escape sequence is to be |
1526 | C<default> to indicate that the default-colour escape sequence is to be |
1482 | used), C<bg> is the colour code used as default background colour (or the |
1527 | used), C<bg> is the colour code used as default background colour (or the |
1483 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1528 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1484 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
1529 | was compiled with background image support. Libraries like C<ncurses> |
1485 | (and do) use this information to optimize screen output. |
1530 | and C<slang> can (and do) use this information to optimize screen output. |
1486 | |
1531 | |
1487 | =item B<WINDOWID> |
1532 | =item B<WINDOWID> |
1488 | |
1533 | |
1489 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1534 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1490 | window, which usually has subwindows for the scrollbar, the terminal |
1535 | window, which usually has subwindows for the scrollbar, the terminal |
… | |
… | |
1581 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1626 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1582 | |
1627 | |
1583 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1628 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1584 | |
1629 | |
1585 | Rewrote screen display and text selection routines. |
1630 | Rewrote screen display and text selection routines. |
1586 | |
1631 | |
1587 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1632 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1588 | |
1633 | |
1589 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1634 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1590 | |
1635 | |
1591 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1636 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |