… | |
… | |
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 | |
… | |
… | |
177 | horizontal radii are considered to be the same. Setting one of the |
182 | 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 |
183 | radii to 1 and another to a large number creates interesting effects |
179 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
180 | resource I<blurRadius>. |
185 | resource I<blurRadius>. |
181 | |
186 | |
|
|
187 | =item B<-icon> I<file> |
|
|
188 | |
|
|
189 | Compile I<afterimage>: Use the specified image as application icon. This |
|
|
190 | is used by many window managers, taskbars and pagers to represent the |
|
|
191 | application window; resource I<iconFile>. |
|
|
192 | |
182 | =item B<-bg> I<colour> |
193 | =item B<-bg> I<colour> |
183 | |
194 | |
184 | Window background colour; resource B<background>. |
195 | Window background colour; resource B<background>. |
185 | |
196 | |
186 | =item B<-fg> I<colour> |
197 | =item B<-fg> I<colour> |
… | |
… | |
310 | |
321 | |
311 | =item B<-bc>|B<+bc> |
322 | =item B<-bc>|B<+bc> |
312 | |
323 | |
313 | Blink the cursor; resource B<cursorBlink>. |
324 | Blink the cursor; resource B<cursorBlink>. |
314 | |
325 | |
|
|
326 | =item B<-uc>|B<+uc> |
|
|
327 | |
|
|
328 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
329 | |
315 | =item B<-iconic> |
330 | =item B<-iconic> |
316 | |
331 | |
317 | Start iconified, if the window manager supports that option. |
332 | Start iconified, if the window manager supports that option. |
318 | Alternative form is B<-ic>. |
333 | Alternative form is B<-ic>. |
319 | |
334 | |
… | |
… | |
335 | |
350 | |
336 | =item B<-bl> |
351 | =item B<-bl> |
337 | |
352 | |
338 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
353 | 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 |
354 | if honoured by the WM, the rxvt-unicode window will not have window |
340 | decorations; resource B<borderLess>. |
355 | decorations; resource B<borderLess>. If the window manager does not |
|
|
356 | support MWM hints (e.g. kwin), enables override-redirect mode. |
341 | |
357 | |
342 | =item B<-override-redirect> |
358 | =item B<-override-redirect> |
343 | |
359 | |
344 | Compile I<frills>: Sets override-redirect on the window; resource |
360 | Compile I<frills>: Sets override-redirect on the window; resource |
345 | B<override-redirect>. |
361 | B<override-redirect>. |
… | |
… | |
354 | =item B<-lsp> I<number> |
370 | =item B<-lsp> I<number> |
355 | |
371 | |
356 | Compile I<frills>: Lines (pixel height) to insert between each row of |
372 | Compile I<frills>: Lines (pixel height) to insert between each row of |
357 | the display. Useful to work around font rendering problems; resource |
373 | the display. Useful to work around font rendering problems; resource |
358 | B<lineSpace>. |
374 | B<lineSpace>. |
|
|
375 | |
|
|
376 | =item B<-letsp> I<number> |
|
|
377 | |
|
|
378 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
379 | to control overall letter spacing. Negative values will tighten up the |
|
|
380 | letter spacing, positive values will space letters out more. Useful to |
|
|
381 | work around odd font metrics; resource B<letterSpace>. |
359 | |
382 | |
360 | =item B<-tn> I<termname> |
383 | =item B<-tn> I<termname> |
361 | |
384 | |
362 | This option specifies the name of the terminal type to be set in the |
385 | This option specifies the name of the terminal type to be set in the |
363 | B<TERM> environment variable. This terminal type must exist in the |
386 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
449 | |
472 | |
450 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
473 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
451 | will not immediately destroy its window when the program executed within |
474 | 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 |
475 | it exits. Instead, it will wait till it is being killed or closed by the |
453 | user; resource B<hold>. |
476 | user; resource B<hold>. |
|
|
477 | |
|
|
478 | =item B<-cd> I<path> |
|
|
479 | |
|
|
480 | Sets the working directory for the shell (or the command specified via |
|
|
481 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
482 | @@RXVT_NAME@@ to start; resource B<chdir>. |
454 | |
483 | |
455 | =item B<-xrm> I<string> |
484 | =item B<-xrm> I<string> |
456 | |
485 | |
457 | Works like the X Toolkit option of the same name, by adding the I<string> |
486 | 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 |
487 | as if it were specified in a resource file. Resource values specified this |
… | |
… | |
567 | =item B<depth:> I<bitdepth> |
596 | =item B<depth:> I<bitdepth> |
568 | |
597 | |
569 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
598 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
570 | option B<-depth>. |
599 | option B<-depth>. |
571 | |
600 | |
|
|
601 | =item B<buffered:> I<boolean> |
|
|
602 | |
|
|
603 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
604 | On some card/driver combination enabling it slightly decreases |
|
|
605 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
606 | should normally be enabled. |
|
|
607 | |
572 | =item B<geometry:> I<geom> |
608 | =item B<geometry:> I<geom> |
573 | |
609 | |
574 | Create the window with the specified X window geometry [default 80x24]; |
610 | Create the window with the specified X window geometry [default 80x24]; |
575 | option B<-geometry>. |
611 | option B<-geometry>. |
576 | |
612 | |
… | |
… | |
694 | |
730 | |
695 | Specify background blending type; option B<-blt>. |
731 | Specify background blending type; option B<-blt>. |
696 | |
732 | |
697 | =item B<blurRadius:> I<number> |
733 | =item B<blurRadius:> I<number> |
698 | |
734 | |
699 | Apply Gaussian Blurr with the specified radius to the transparent |
735 | Apply gaussian blur with the specified radius to the transparent |
700 | background image; option B<-blr>. |
736 | background image; option B<-blr>. |
|
|
737 | |
|
|
738 | =item B<iconFile:> I<file> |
|
|
739 | |
|
|
740 | Set the application icon pixmap; option B<-icon>. |
701 | |
741 | |
702 | =item B<scrollColor:> I<colour> |
742 | =item B<scrollColor:> I<colour> |
703 | |
743 | |
704 | Use the specified colour for the scrollbar [default #B2B2B2]. |
744 | Use the specified colour for the scrollbar [default #B2B2B2]. |
705 | |
745 | |
… | |
… | |
833 | =item B<urgentOnBell:> I<boolean> |
873 | =item B<urgentOnBell:> I<boolean> |
834 | |
874 | |
835 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
875 | 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]. |
876 | B<False>: do not set the urgency hint [default]. |
837 | |
877 | |
|
|
878 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
879 | |
838 | =item B<visualBell:> I<boolean> |
880 | =item B<visualBell:> I<boolean> |
839 | |
881 | |
840 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
882 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
841 | B<False>: no visual bell [default]; option B<+vb>. |
883 | B<False>: no visual bell [default]; option B<+vb>. |
842 | |
884 | |
… | |
… | |
965 | |
1007 | |
966 | =item B<cursorBlink:> I<boolean> |
1008 | =item B<cursorBlink:> I<boolean> |
967 | |
1009 | |
968 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1010 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
969 | option B<-bc>. |
1011 | option B<-bc>. |
|
|
1012 | |
|
|
1013 | =item B<cursorUnderline:> I<boolean> |
|
|
1014 | |
|
|
1015 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
1016 | option B<-uc>. |
970 | |
1017 | |
971 | =item B<pointerBlank:> I<boolean> |
1018 | =item B<pointerBlank:> I<boolean> |
972 | |
1019 | |
973 | B<True>: blank the pointer when a key is pressed or after a set number |
1020 | B<True>: blank the pointer when a key is pressed or after a set number |
974 | of seconds of inactivity. B<False>: the pointer is always visible |
1021 | of seconds of inactivity. B<False>: the pointer is always visible |
… | |
… | |
1077 | |
1124 | |
1078 | =item B<secondaryScroll:> I<boolean> |
1125 | =item B<secondaryScroll:> I<boolean> |
1079 | |
1126 | |
1080 | Turn on/off secondary screen scroll (default enabled). If this |
1127 | Turn on/off secondary screen scroll (default enabled). If this |
1081 | option is enabled, scrolls on the secondary screen will change the |
1128 | option is enabled, scrolls on the secondary screen will change the |
1082 | scrollback buffer and switching to/from the secondary screen will |
1129 | scrollback buffer and, when secondaryScreen is off, switching |
1083 | instead scroll the screen up. |
1130 | to/from the secondary screen will instead scroll the screen up. |
1084 | |
1131 | |
1085 | =item B<hold>: I<boolean> |
1132 | =item B<hold>: I<boolean> |
1086 | |
1133 | |
1087 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1134 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1088 | will not immediately destroy its window when the program executed within |
1135 | 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 |
1136 | it exits. Instead, it will wait till it is being killed or closed by the |
1090 | user. |
1137 | user. |
|
|
1138 | |
|
|
1139 | =item B<chdir>: I<path> |
|
|
1140 | |
|
|
1141 | Sets the working directory for the shell (or the command specified via |
|
|
1142 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1143 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1144 | directory will be used; option B<-cd>. |
1091 | |
1145 | |
1092 | =item B<keysym.>I<sym>: I<string> |
1146 | =item B<keysym.>I<sym>: I<string> |
1093 | |
1147 | |
1094 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1148 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1095 | intervening resource name B<keysym.> cannot be omitted. |
1149 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1134 | when Control-Meta-c is being pressed": |
1188 | when Control-Meta-c is being pressed": |
1135 | |
1189 | |
1136 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1190 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1137 | |
1191 | |
1138 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1192 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1139 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1193 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1140 | manpage. For example, the F<selection> extension (activated via |
1194 | manpage. For example, the F<selection> extension (activated via |
1141 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1195 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1142 | |
1196 | |
1143 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1197 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1144 | |
1198 | |
… | |
… | |
1202 | all instances, while B<perl-ext> is used for specific instances. |
1256 | all instances, while B<perl-ext> is used for specific instances. |
1203 | |
1257 | |
1204 | =item B<perl-eval>: I<string> |
1258 | =item B<perl-eval>: I<string> |
1205 | |
1259 | |
1206 | Perl code to be evaluated when all extensions have been registered. See |
1260 | 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 |
1261 | the @@RXVT_NAME@@perl(3) manpage. |
1208 | will be ignored when running setuid/setgid. |
|
|
1209 | |
1262 | |
1210 | =item B<perl-lib>: I<path> |
1263 | =item B<perl-lib>: I<path> |
1211 | |
1264 | |
1212 | Colon-separated list of additional directories that hold extension |
1265 | Colon-separated list of additional directories that hold extension |
1213 | scripts. When looking for extensions specified by the C<perl> resource, |
1266 | scripts. When looking for extensions specified by the C<perl> resource, |
1214 | @@RXVT_NAME@@ will first look in these directories and then in |
1267 | @@RXVT_NAME@@ will first look in these directories and then in |
1215 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1268 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1216 | will be ignored when running setuid/setgid. |
|
|
1217 | |
1269 | |
1218 | See the @@RXVT_NAME@@perl(3) manpage. |
1270 | See the @@RXVT_NAME@@perl(3) manpage. |
1219 | |
1271 | |
1220 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1272 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1221 | |
1273 | |
… | |
… | |
1444 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1496 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1445 | always swapping the foreground/background colours. This is in contrast to |
1497 | always swapping the foreground/background colours. This is in contrast to |
1446 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1498 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1447 | been specified. For example, |
1499 | been specified. For example, |
1448 | |
1500 | |
1449 | =over 4 |
|
|
1450 | |
|
|
1451 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1501 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1452 | |
1502 | |
1453 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1503 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1454 | on White. |
1504 | White. |
1455 | |
1505 | |
1456 | =back |
1506 | =head2 ALPHA CHANNEL SUPPORT |
1457 | |
|
|
1458 | =head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS |
|
|
1459 | |
1507 | |
1460 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1508 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1461 | their act together, rxvt-unicode will do it's own alpha channel management: |
1509 | their act together, rxvt-unicode will do it's own alpha channel management: |
1462 | |
1510 | |
1463 | You can prefix any color with an opaquenes percentage enclosed in |
1511 | You can prefix any color with an opaquenes percentage enclosed in |
… | |
… | |
1541 | C<--with-terminfo=PATH>. |
1589 | C<--with-terminfo=PATH>. |
1542 | |
1590 | |
1543 | =item B<DISPLAY> |
1591 | =item B<DISPLAY> |
1544 | |
1592 | |
1545 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1593 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1546 | display in its child processes. |
1594 | display in its child processes if C<-display> isn't used to override. It |
|
|
1595 | defaults to C<:0> if it doesn't exist. |
1547 | |
1596 | |
1548 | =item B<SHELL> |
1597 | =item B<SHELL> |
1549 | |
1598 | |
1550 | The shell to be used for command execution, defaults to C</bin/sh>. |
1599 | The shell to be used for command execution, defaults to C</bin/sh>. |
1551 | |
1600 | |