| … | |
… | |
| 92 | |
92 | |
| 93 | Print out a message describing available options. |
93 | Print out a message describing available options. |
| 94 | |
94 | |
| 95 | =item B<-display> I<displayname> |
95 | =item B<-display> I<displayname> |
| 96 | |
96 | |
| 97 | Attempt to open a window on the named X display (B<-d> still |
97 | Attempt to open a window on the named X display (the older form B<-d> |
| 98 | respected). In the absence of this option, the display specified by the |
98 | is still respected. but deprecated). In the absence of this option, the |
| 99 | 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<xft>: Attempt to find a visual with the given bit depth; |
| 104 | resource B<depth>. |
104 | resource B<depth>. |
|
|
105 | |
|
|
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 |
|
|
108 | of graphical corruption. This is harmless, but we can't do anything about |
|
|
109 | this, so watch out] |
| 105 | |
110 | |
| 106 | =item B<-geometry> I<geom> |
111 | =item B<-geometry> I<geom> |
| 107 | |
112 | |
| 108 | Window geometry (B<-g> still respected); resource B<geometry>. |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
| 109 | |
114 | |
| … | |
… | |
| 335 | |
340 | |
| 336 | =item B<-bl> |
341 | =item B<-bl> |
| 337 | |
342 | |
| 338 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
343 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
| 339 | if honoured by the WM, the rxvt-unicode window will not have window |
344 | if honoured by the WM, the rxvt-unicode window will not have window |
| 340 | decorations; resource B<borderLess>. |
345 | decorations; resource B<borderLess>. If the window manager does not |
|
|
346 | support MWM hints (e.g. kwin), enables override-redirect mode. |
| 341 | |
347 | |
| 342 | =item B<-override-redirect> |
348 | =item B<-override-redirect> |
| 343 | |
349 | |
| 344 | Compile I<frills>: Sets override-redirect on the window; resource |
350 | Compile I<frills>: Sets override-redirect on the window; resource |
| 345 | B<override-redirect>. |
351 | B<override-redirect>. |
| … | |
… | |
| 449 | |
455 | |
| 450 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
456 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
| 451 | will not immediately destroy its window when the program executed within |
457 | will not immediately destroy its window when the program executed within |
| 452 | it exits. Instead, it will wait till it is being killed or closed by the |
458 | it exits. Instead, it will wait till it is being killed or closed by the |
| 453 | user; resource B<hold>. |
459 | user; resource B<hold>. |
|
|
460 | |
|
|
461 | =item B<-cd> I<path> |
|
|
462 | |
|
|
463 | Sets the working directory for the shell (or the command specified via |
|
|
464 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
465 | @@RXVT_NAME@@ to start; resource B<chdir>. |
| 454 | |
466 | |
| 455 | =item B<-xrm> I<string> |
467 | =item B<-xrm> I<string> |
| 456 | |
468 | |
| 457 | Works like the X Toolkit option of the same name, by adding the I<string> |
469 | 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 |
470 | as if it were specified in a resource file. Resource values specified this |
| … | |
… | |
| 567 | =item B<depth:> I<bitdepth> |
579 | =item B<depth:> I<bitdepth> |
| 568 | |
580 | |
| 569 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
581 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
| 570 | option B<-depth>. |
582 | option B<-depth>. |
| 571 | |
583 | |
|
|
584 | =item B<buffered:> I<boolean> |
|
|
585 | |
|
|
586 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
587 | On some card/driver combination enabling it slightly decreases |
|
|
588 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
589 | should normally be enabled. |
|
|
590 | |
| 572 | =item B<geometry:> I<geom> |
591 | =item B<geometry:> I<geom> |
| 573 | |
592 | |
| 574 | Create the window with the specified X window geometry [default 80x24]; |
593 | Create the window with the specified X window geometry [default 80x24]; |
| 575 | option B<-geometry>. |
594 | option B<-geometry>. |
| 576 | |
595 | |
| … | |
… | |
| 833 | =item B<urgentOnBell:> I<boolean> |
852 | =item B<urgentOnBell:> I<boolean> |
| 834 | |
853 | |
| 835 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
854 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
| 836 | B<False>: do not set the urgency hint [default]. |
855 | B<False>: do not set the urgency hint [default]. |
| 837 | |
856 | |
|
|
857 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
858 | |
| 838 | =item B<visualBell:> I<boolean> |
859 | =item B<visualBell:> I<boolean> |
| 839 | |
860 | |
| 840 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
861 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
| 841 | B<False>: no visual bell [default]; option B<+vb>. |
862 | B<False>: no visual bell [default]; option B<+vb>. |
| 842 | |
863 | |
| … | |
… | |
| 1077 | |
1098 | |
| 1078 | =item B<secondaryScroll:> I<boolean> |
1099 | =item B<secondaryScroll:> I<boolean> |
| 1079 | |
1100 | |
| 1080 | Turn on/off secondary screen scroll (default enabled). If this |
1101 | Turn on/off secondary screen scroll (default enabled). If this |
| 1081 | option is enabled, scrolls on the secondary screen will change the |
1102 | option is enabled, scrolls on the secondary screen will change the |
| 1082 | scrollback buffer and switching to/from the secondary screen will |
1103 | scrollback buffer and, when secondaryScreen is off, switching |
| 1083 | instead scroll the screen up. |
1104 | to/from the secondary screen will instead scroll the screen up. |
| 1084 | |
1105 | |
| 1085 | =item B<hold>: I<boolean> |
1106 | =item B<hold>: I<boolean> |
| 1086 | |
1107 | |
| 1087 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1108 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
| 1088 | will not immediately destroy its window when the program executed within |
1109 | will not immediately destroy its window when the program executed within |
| 1089 | it exits. Instead, it will wait till it is being killed or closed by the |
1110 | it exits. Instead, it will wait till it is being killed or closed by the |
| 1090 | user. |
1111 | user. |
|
|
1112 | |
|
|
1113 | =item B<chdir>: I<path> |
|
|
1114 | |
|
|
1115 | Sets the working directory for the shell (or the command specified via |
|
|
1116 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1117 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1118 | directory will be used; option B<-cd>. |
| 1091 | |
1119 | |
| 1092 | =item B<keysym.>I<sym>: I<string> |
1120 | =item B<keysym.>I<sym>: I<string> |
| 1093 | |
1121 | |
| 1094 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1122 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
| 1095 | intervening resource name B<keysym.> cannot be omitted. |
1123 | intervening resource name B<keysym.> cannot be omitted. |
| … | |
… | |
| 1202 | all instances, while B<perl-ext> is used for specific instances. |
1230 | all instances, while B<perl-ext> is used for specific instances. |
| 1203 | |
1231 | |
| 1204 | =item B<perl-eval>: I<string> |
1232 | =item B<perl-eval>: I<string> |
| 1205 | |
1233 | |
| 1206 | Perl code to be evaluated when all extensions have been registered. See |
1234 | Perl code to be evaluated when all extensions have been registered. See |
| 1207 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1235 | the @@RXVT_NAME@@perl(3) manpage. |
| 1208 | will be ignored when running setuid/setgid. |
|
|
| 1209 | |
1236 | |
| 1210 | =item B<perl-lib>: I<path> |
1237 | =item B<perl-lib>: I<path> |
| 1211 | |
1238 | |
| 1212 | Colon-separated list of additional directories that hold extension |
1239 | Colon-separated list of additional directories that hold extension |
| 1213 | scripts. When looking for extensions specified by the C<perl> resource, |
1240 | scripts. When looking for extensions specified by the C<perl> resource, |
| 1214 | @@RXVT_NAME@@ will first look in these directories and then in |
1241 | @@RXVT_NAME@@ will first look in these directories and then in |
| 1215 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1242 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
| 1216 | will be ignored when running setuid/setgid. |
|
|
| 1217 | |
1243 | |
| 1218 | See the @@RXVT_NAME@@perl(3) manpage. |
1244 | See the @@RXVT_NAME@@perl(3) manpage. |
| 1219 | |
1245 | |
| 1220 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1246 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
| 1221 | |
1247 | |
| … | |
… | |
| 1456 | =back |
1482 | =back |
| 1457 | |
1483 | |
| 1458 | =head2 ALPHA CHANNEL SUPPORT |
1484 | =head2 ALPHA CHANNEL SUPPORT |
| 1459 | |
1485 | |
| 1460 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1486 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
| 1461 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1487 | their act together, rxvt-unicode will do it's own alpha channel management: |
| 1462 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1488 | |
| 1463 | in addition to the ones provided by X, where the additional A component |
1489 | You can prefix any color with an opaquenes percentage enclosed in |
|
|
1490 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1491 | (0-100) that specifies the opacity of the color, where C<0> is completely |
|
|
1492 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1493 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1494 | is the recommended format to specify transparency values, and works with |
|
|
1495 | all ways to specify a colour. |
|
|
1496 | |
|
|
1497 | For complete control, rxvt-unicode also supports |
|
|
1498 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1499 | specifications, where the additional C<aaaa> component specifies opacity |
| 1464 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1500 | (alpha) values. The minimum value of C<0000> is completely transparent, |
| 1465 | transparent). You can also prefix any color with C<[percent]>, where |
1501 | while C<ffff> is completely opaque). The two example colours from |
| 1466 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
1502 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
| 1467 | the color, where C<0> is completely transparent and C<100> is completelxy |
1503 | C<rgba:0000/ff00/0000/f332>. |
| 1468 | opaque. |
|
|
| 1469 | |
1504 | |
| 1470 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1505 | You probably need to specify B<"-depth 32">, too, to force a visual with |
| 1471 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1506 | alpha channels, and have the luck that your X-server uses ARGB pixel |
| 1472 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1507 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1508 | rxvt-unicode just fudges around. |
| 1473 | |
1509 | |
| 1474 | For example, the following selects an almost completely transparent red |
1510 | For example, the following selects an almost completely transparent black |
| 1475 | background, and an almost opaque pink foreground: |
1511 | background, and an almost opaque pink foreground: |
| 1476 | |
1512 | |
| 1477 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1513 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
| 1478 | |
1514 | |
| 1479 | I<Please note that transparency of any kind if completely unsupported by |
1515 | When not using a background image, then the interpretation of the |
| 1480 | the author. Don't bug him with installation questions!> |
1516 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1517 | transparency of course). |
|
|
1518 | |
|
|
1519 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1520 | colour will always behave as if it were completely transparent (so the |
|
|
1521 | background image shows instead), regardless of how it was specified, while |
|
|
1522 | other colours will either be transparent as specified (the background |
|
|
1523 | image will show through) on servers supporting the RENDER extension, or |
|
|
1524 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1525 | |
|
|
1526 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1527 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1528 | extension. |
| 1481 | |
1529 | |
| 1482 | =head1 ENVIRONMENT |
1530 | =head1 ENVIRONMENT |
| 1483 | |
1531 | |
| 1484 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1532 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
| 1485 | |
1533 | |
| … | |
… | |
| 1519 | C<--with-terminfo=PATH>. |
1567 | C<--with-terminfo=PATH>. |
| 1520 | |
1568 | |
| 1521 | =item B<DISPLAY> |
1569 | =item B<DISPLAY> |
| 1522 | |
1570 | |
| 1523 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1571 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
| 1524 | display in its child processes. |
1572 | display in its child processes if C<-display> isn't used to override. It |
|
|
1573 | defaults to C<:0> if it doesn't exist. |
| 1525 | |
1574 | |
| 1526 | =item B<SHELL> |
1575 | =item B<SHELL> |
| 1527 | |
1576 | |
| 1528 | The shell to be used for command execution, defaults to C</bin/sh>. |
1577 | The shell to be used for command execution, defaults to C</bin/sh>. |
| 1529 | |
1578 | |
