… | |
… | |
189 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
189 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
190 | section of @@RXVT_NAME@@(7). |
190 | section of @@RXVT_NAME@@(7). |
191 | |
191 | |
192 | =item B<-fb> I<fontlist> |
192 | =item B<-fb> I<fontlist> |
193 | |
193 | |
194 | Compile font-styles: The bold font list to use when bold characters are to |
194 | Compile I<font-styles>: The bold font list to use when B<bold> characters |
195 | be printed. See resource B<boldFont> for details. |
195 | are to be printed. See resource B<boldFont> for details. |
196 | |
196 | |
197 | =item B<-fi> I<fontlist> |
197 | =item B<-fi> I<fontlist> |
198 | |
198 | |
199 | Compile font-styles: The italic font list to use when bold characters are to |
199 | Compile I<font-styles>: The italic font list to use when I<italic> |
200 | be printed. See resource B<italicFont> for details. |
200 | characters are to be printed. See resource B<italicFont> for details. |
201 | |
201 | |
202 | =item B<-fbi> I<fontlist> |
202 | =item B<-fbi> I<fontlist> |
203 | |
203 | |
204 | Compile font-styles: The bold italic font list to use when bold characters are to |
204 | Compile I<font-styles>: The bold italic font list to use when B<< I<bold |
205 | be printed. See resource B<boldItalicFont> for details. |
205 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
|
|
206 | for details. |
|
|
207 | |
|
|
208 | =item B<-is>|B<+is> |
|
|
209 | |
|
|
210 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
|
|
211 | foreground/background (default). See resource B<intensityStyles> for |
|
|
212 | details. |
206 | |
213 | |
207 | =item B<-name> I<name> |
214 | =item B<-name> I<name> |
208 | |
215 | |
209 | Specify the application name under which resources are to be obtained, |
216 | Specify the application name under which resources are to be obtained, |
210 | rather than the default executable file name. Name should not contain |
217 | rather than the default executable file name. Name should not contain |
… | |
… | |
289 | =item B<-bl> |
296 | =item B<-bl> |
290 | |
297 | |
291 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
298 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
292 | if honoured by the WM, the rxvt-unicode window will not have window |
299 | if honoured by the WM, the rxvt-unicode window will not have window |
293 | decorations; resource B<borderLess>. |
300 | decorations; resource B<borderLess>. |
|
|
301 | |
|
|
302 | =item B<-sbg> |
|
|
303 | |
|
|
304 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
305 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
306 | this if you have a good font and want to use its block graphic glyphs; |
|
|
307 | resource B<skipBuiltinGlyphs>. |
294 | |
308 | |
295 | =item B<-lsp> I<number> |
309 | =item B<-lsp> I<number> |
296 | |
310 | |
297 | Compile I<frills>: Lines (pixel height) to insert between each row of |
311 | Compile I<frills>: Lines (pixel height) to insert between each row of |
298 | the display. Useful to work around font rendering problems; resource |
312 | the display. Useful to work around font rendering problems; resource |
… | |
… | |
421 | $rxvt->signal_connect_after (realize => sub { |
435 | $rxvt->signal_connect_after (realize => sub { |
422 | my $xid = $_[0]->window->get_xid; |
436 | my $xid = $_[0]->window->get_xid; |
423 | system "@@RXVT_NAME@@ -embed $xid &"; |
437 | system "@@RXVT_NAME@@ -embed $xid &"; |
424 | }); |
438 | }); |
425 | |
439 | |
426 | =item B<-pty-fd> I<fileno> |
440 | =item B<-pty-fd> I<file descriptor> |
427 | |
441 | |
428 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
442 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
429 | pair but instead use the given filehandle as the tty master. This is |
443 | pair but instead use the given filehandle as the tty master. This is |
430 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
444 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
431 | without having to run a program within it. |
445 | without having to run a program within it. |
432 | |
446 | |
433 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
447 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
434 | entries and will not tinker with pty/tty permissions - you have to do that |
448 | entries and will not tinker with pty/tty permissions - you have to do that |
435 | yourself if you want that. |
449 | yourself if you want that. |
436 | |
450 | |
|
|
451 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
452 | pty/tty operations. |
|
|
453 | |
437 | Here is a example in perl that illustrates how this option can be used (a |
454 | Here is a example in perl that illustrates how this option can be used (a |
438 | longer example is in F<doc/pty-fd>): |
455 | longer example is in F<doc/pty-fd>): |
439 | |
456 | |
440 | use IO::Pty; |
457 | use IO::Pty; |
441 | use Fcntl; |
458 | use Fcntl; |
… | |
… | |
447 | |
464 | |
448 | # now communicate with rxvt |
465 | # now communicate with rxvt |
449 | my $slave = $pty->slave; |
466 | my $slave = $pty->slave; |
450 | while (<$slave>) { print $slave "got <$_>\n" } |
467 | while (<$slave>) { print $slave "got <$_>\n" } |
451 | |
468 | |
|
|
469 | =item B<-pe> I<string> |
|
|
470 | |
|
|
471 | Comma-separated list of perl extension scripts to use (or not to use) in |
|
|
472 | this terminal instance. See resource B<perl-ext> for details. |
|
|
473 | |
452 | =back |
474 | =back |
453 | |
475 | |
454 | =head1 RESOURCES (available also as long-options) |
476 | =head1 RESOURCES (available also as long-options) |
455 | |
477 | |
456 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
478 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
457 | options) compiled into your version. |
479 | options) compiled into your version. |
458 | |
480 | |
459 | There are two different methods that @@RXVT_NAME@@ can use to get the |
481 | You can set and change the resources using X11 tools like B<xrdb>. Many |
460 | Xresource data: using the X libraries (Xrm*-functions) or internal |
482 | distribution do also load settings from the B<~/.Xresources> file when X |
461 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
483 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
462 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
484 | with later settings overwriting earlier ones: |
463 | resources using X11 tools like B<xrdb>. Many distribution do also load |
|
|
464 | settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ |
|
|
465 | will consult the following files/resources in order, with later settings |
|
|
466 | overwriting earlier ones: |
|
|
467 | |
485 | |
468 | 1. system-wide app-defaults file, either locale-dependent OR global |
486 | 1. system-wide app-defaults file, either locale-dependent OR global |
469 | 2. app-defaults file in $XAPPLRESDIR |
487 | 2. app-defaults file in $XAPPLRESDIR |
470 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
488 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
471 | 4. SCREEN_RESOURCES for the current screen |
489 | 4. SCREEN_RESOURCES for the current screen |
472 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
490 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
473 | |
491 | |
474 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
|
|
475 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
|
|
476 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
|
|
477 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
|
|
478 | B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
|
|
479 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
492 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
480 | class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows |
493 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
481 | resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be |
494 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
482 | easily configured, while the class name B<URxvt> allows resources |
495 | configured, while the class name B<URxvt> allows resources unique to |
483 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
496 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
484 | shared between different B<@@RXVT_NAME@@> configurations. If no |
497 | configurations. If no resources are specified, suitable defaults will |
485 | resources are specified, suitable defaults will be used. Command-line |
498 | be used. Command-line arguments can be used to override resource |
486 | arguments can be used to override resource settings. The following |
499 | settings. The following resources are supported (you might want to |
487 | resources are allowed: |
500 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
501 | extensions not documented here): |
488 | |
502 | |
489 | =over 4 |
503 | =over 4 |
490 | |
504 | |
491 | =item B<geometry:> I<geom> |
505 | =item B<geometry:> I<geom> |
492 | |
506 | |
… | |
… | |
631 | |
645 | |
632 | Select the fonts to be used. This is a comma separated list of font |
646 | Select the fonts to be used. This is a comma separated list of font |
633 | names that are used in turn when trying to display Unicode characters. |
647 | names that are used in turn when trying to display Unicode characters. |
634 | The first font defines the cell size for characters; other fonts might |
648 | The first font defines the cell size for characters; other fonts might |
635 | be smaller, but not larger. A reasonable default font list is always |
649 | be smaller, but not larger. A reasonable default font list is always |
636 | appended to it. option B<-fn>. |
650 | appended to it; option B<-fn>. |
637 | |
651 | |
638 | Each font can either be a standard X11 core font (XLFD) name, with |
652 | Each font can either be a standard X11 core font (XLFD) name, with |
639 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
653 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
640 | |
654 | |
641 | In addition, each font can be prefixed with additional hints and |
655 | In addition, each font can be prefixed with additional hints and |
… | |
… | |
687 | not possible, replacement fonts of the desired shape will be tried. |
701 | not possible, replacement fonts of the desired shape will be tried. |
688 | |
702 | |
689 | If set, but empty, then this specific style is disabled and the normal |
703 | If set, but empty, then this specific style is disabled and the normal |
690 | text font will being used for the given style. |
704 | text font will being used for the given style. |
691 | |
705 | |
|
|
706 | =item B<intensityStyles:> I<boolean> |
|
|
707 | |
|
|
708 | When font styles are not enabled, or this option is enabled (B<True>, |
|
|
709 | option B<-is>, the default), bold and italic font styles imply high |
|
|
710 | intensity foreground/backround colours. Disabling this option (B<False>, |
|
|
711 | option B<+is>) disables this behaviour, the high intensity colours are not |
|
|
712 | reachable. |
|
|
713 | |
692 | =item B<selectstyle:> I<mode> |
714 | =item B<selectstyle:> I<mode> |
693 | |
715 | |
694 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
716 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
695 | xterm style with 2.20 old word selection, or anything else which gives |
717 | xterm style with 2.20 old word selection, or anything else which gives |
696 | xterm style selection. |
718 | xterm style selection. |
… | |
… | |
806 | =item B<borderLess:> I<boolean> |
828 | =item B<borderLess:> I<boolean> |
807 | |
829 | |
808 | Set MWM hints to request a borderless window, i.e. if honoured by the |
830 | Set MWM hints to request a borderless window, i.e. if honoured by the |
809 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
831 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
810 | |
832 | |
|
|
833 | =item B<skipBuiltinGlyphs:> I<boolean> |
|
|
834 | |
|
|
835 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
836 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
837 | this if you have a good font and want to use its block graphic glyphs; |
|
|
838 | option B<-sbg>. |
|
|
839 | |
811 | =item B<termName:> I<termname> |
840 | =item B<termName:> I<termname> |
812 | |
841 | |
813 | Specifies the terminal type name to be set in the B<TERM> environment |
842 | Specifies the terminal type name to be set in the B<TERM> environment |
814 | variable; option B<-tn>. |
843 | variable; option B<-tn>. |
815 | |
844 | |
… | |
… | |
888 | =item B<imLocale:> I<name> |
917 | =item B<imLocale:> I<name> |
889 | |
918 | |
890 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
919 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
891 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
920 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
892 | input extension to be able to input japanese characters while staying in |
921 | input extension to be able to input japanese characters while staying in |
893 | another locale. option B<-imlocale>. |
922 | another locale; option B<-imlocale>. |
894 | |
923 | |
895 | =item B<imFont:> I<fontset> |
924 | =item B<imFont:> I<fontset> |
896 | |
925 | |
897 | Specify the font-set used for XIM styles C<OverTheSpot> or |
926 | Specify the font-set used for XIM styles C<OverTheSpot> or |
898 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
927 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
… | |
… | |
903 | |
932 | |
904 | =item B<tripleclickwords:> I<boolean> |
933 | =item B<tripleclickwords:> I<boolean> |
905 | |
934 | |
906 | Change the meaning of triple-click selection with the left mouse |
935 | Change the meaning of triple-click selection with the left mouse |
907 | button. Instead of selecting a full line it will extend the selection to |
936 | button. Instead of selecting a full line it will extend the selection to |
908 | the end of the logical line only. option B<-tcw>. |
937 | the end of the logical line only; option B<-tcw>. |
909 | |
938 | |
910 | =item B<insecure:> I<boolean> |
939 | =item B<insecure:> I<boolean> |
911 | |
940 | |
912 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
941 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
913 | echo arbitrary strings like the icon name or the locale. This could be |
942 | echo arbitrary strings like the icon name or the locale. This could be |
… | |
… | |
978 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1007 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
979 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1008 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
980 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1009 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
981 | can start or end with whitespace. |
1010 | can start or end with whitespace. |
982 | |
1011 | |
983 | Please note that you need to double the C<\> when using |
1012 | Please note that you need to double the C<\> in resource files, as |
984 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
1013 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
985 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
1014 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
986 | @@RXVT_NAME@@'s own processing). |
1015 | processing). |
987 | |
1016 | |
988 | You can define a range of keysyms in one shot by providing a I<string> |
1017 | You can define a range of keysyms in one shot by providing a I<string> |
989 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1018 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
990 | should be a character not used by the strings. |
1019 | should be a character not used by the strings. |
991 | |
1020 | |
… | |
… | |
1003 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1032 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1004 | example the following means "change the current locale to C<zh_CN.GBK> |
1033 | example the following means "change the current locale to C<zh_CN.GBK> |
1005 | when Control-Meta-c is being pressed": |
1034 | when Control-Meta-c is being pressed": |
1006 | |
1035 | |
1007 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1036 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
1037 | |
|
|
1038 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
|
|
1039 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
|
|
1040 | manpage. For example, the F<selection> extension (activated via |
|
|
1041 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1042 | |
|
|
1043 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1008 | |
1044 | |
1009 | Due the the large number of modifier combinations, a defined key mapping |
1045 | Due the the large number of modifier combinations, a defined key mapping |
1010 | will match if at I<at least> the specified identifiers are being set, and |
1046 | will match if at I<at least> the specified identifiers are being set, and |
1011 | no other key mappings with those and more bits are being defined. That |
1047 | no other key mappings with those and more bits are being defined. That |
1012 | means that defining a key map for C<a> will automatically provide |
1048 | means that defining a key map for C<a> will automatically provide |
… | |
… | |
1035 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1071 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1036 | info): |
1072 | info): |
1037 | |
1073 | |
1038 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1074 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1039 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1075 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1076 | |
|
|
1077 | =item B<perl-ext-common>: I<string> |
|
|
1078 | |
|
|
1079 | =item B<perl-ext>: I<string> |
|
|
1080 | |
|
|
1081 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1082 | use in this terminal instance; option B<-pe>. |
|
|
1083 | |
|
|
1084 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1085 | them. This can be useful to selectively disable some extensions loaded |
|
|
1086 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1087 | example, C<default,-selection> will use all the default extension except |
|
|
1088 | C<selection>. |
|
|
1089 | |
|
|
1090 | Extension names can also be followed by an argument in angle brackets |
|
|
1091 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1092 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
|
|
1093 | multiple times with different arguments will pass multiple arguments to |
|
|
1094 | the extension. |
|
|
1095 | |
|
|
1096 | Each extension is looked up in the library directories, loaded if |
|
|
1097 | necessary, and bound to the current terminal instance. |
|
|
1098 | |
|
|
1099 | If both of these resources are the empty string, then the perl |
|
|
1100 | interpreter will not be initialized. The idea behind two options is that |
|
|
1101 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1102 | all instances, while B<perl-ext> is used for specific instances. |
|
|
1103 | |
|
|
1104 | =item B<perl-eval>: I<string> |
|
|
1105 | |
|
|
1106 | Perl code to be evaluated when all extensions have been registered. See |
|
|
1107 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
|
|
1108 | will be ignored when running setuid/setgid. |
|
|
1109 | |
|
|
1110 | =item B<perl-lib>: I<path> |
|
|
1111 | |
|
|
1112 | Colon-separated list of additional directories that hold extension |
|
|
1113 | scripts. When looking for extensions specified by the C<perl> resource, |
|
|
1114 | @@RXVT_NAME@@ will first look in these directories and then in |
|
|
1115 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
|
|
1116 | will be ignored when running setuid/setgid. |
|
|
1117 | |
|
|
1118 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1119 | |
|
|
1120 | =item B<urlLauncher>: I<string> |
|
|
1121 | |
|
|
1122 | Specifies the program to be started with a URL argument. Used by the |
|
|
1123 | C<selection-popup> and C<mark-urls> perl extensions. |
|
|
1124 | |
|
|
1125 | =item B<transient-for>: I<windowid> |
|
|
1126 | |
|
|
1127 | Sets the WM_TRANSIENT_FOR property to the given window iw. |
1040 | |
1128 | |
1041 | =back |
1129 | =back |
1042 | |
1130 | |
1043 | =head1 THE SCROLLBAR |
1131 | =head1 THE SCROLLBAR |
1044 | |
1132 | |