… | |
… | |
4 | |
4 | |
5 | SYNOPSIS |
5 | SYNOPSIS |
6 | rxvt [options] [-e command [ args ]] |
6 | rxvt [options] [-e command [ args ]] |
7 | |
7 | |
8 | DESCRIPTION |
8 | DESCRIPTION |
9 | rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended |
10 | as an *xterm*(1) replacement for users who do not require features such |
10 | as an *xterm*(1) replacement for users who do not require features such |
11 | as Tektronix 4014 emulation and toolkit-style configurability. As a |
11 | as Tektronix 4014 emulation and toolkit-style configurability. As a |
12 | result, rxvt-unicode uses much less swap space -- a significant |
12 | result, rxvt-unicode uses much less swap space -- a significant |
13 | advantage on a machine serving many X sessions. |
13 | advantage on a machine serving many X sessions. |
14 | |
14 | |
… | |
… | |
146 | The colour of the border around the text area and between the |
146 | The colour of the border around the text area and between the |
147 | scrollbar and the text; resource borderColor. |
147 | scrollbar and the text; resource borderColor. |
148 | |
148 | |
149 | -fn *fontlist* |
149 | -fn *fontlist* |
150 | Select the fonts to be used. This is a comma separated list of font |
150 | Select the fonts to be used. This is a comma separated list of font |
151 | names that are used in turn when trying to display Unicode |
151 | names that are checked in order when trying to find glyphs for |
152 | characters. The first font defines the cell size for characters; |
152 | characters. The first font defines the cell size for characters; |
153 | other fonts might be smaller, but not (in general) larger. A |
153 | other fonts might be smaller, but not (in general) larger. A |
154 | (hopefully) reasonable default font list is always appended to it. |
154 | (hopefully) reasonable default font list is always appended to it. |
155 | See resource font for more details. |
155 | See resource font for more details. |
156 | |
156 | |
… | |
… | |
371 | $rxvt->signal_connect_after (realize => sub { |
371 | $rxvt->signal_connect_after (realize => sub { |
372 | my $xid = $_[0]->window->get_xid; |
372 | my $xid = $_[0]->window->get_xid; |
373 | system "rxvt -embed $xid &"; |
373 | system "rxvt -embed $xid &"; |
374 | }); |
374 | }); |
375 | |
375 | |
376 | -pty-fd *fileno* |
376 | -pty-fd *file descriptor* |
377 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
377 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
378 | but instead use the given filehandle as the tty master. This is |
378 | but instead use the given filehandle as the tty master. This is |
379 | useful if you want to drive rxvt as a generic terminal emulator |
379 | useful if you want to drive rxvt as a generic terminal emulator |
380 | without having to run a program within it. |
380 | without having to run a program within it. |
381 | |
381 | |
382 | If this switch is given, rxvt will not create any utmp/wtmp entries |
382 | If this switch is given, rxvt will not create any utmp/wtmp entries |
383 | and will not tinker with pty/tty permissions - you have to do that |
383 | and will not tinker with pty/tty permissions - you have to do that |
384 | yourself if you want that. |
384 | yourself if you want that. |
385 | |
385 | |
|
|
386 | As an extremely special case, specifying -1 will completely suppress |
|
|
387 | pty/tty operations. |
|
|
388 | |
386 | Here is a example in perl that illustrates how this option can be |
389 | Here is a example in perl that illustrates how this option can be |
387 | used (a longer example is in doc/pty-fd): |
390 | used (a longer example is in doc/pty-fd): |
388 | |
391 | |
389 | use IO::Pty; |
392 | use IO::Pty; |
390 | use Fcntl; |
393 | use Fcntl; |
… | |
… | |
397 | # now communicate with rxvt |
400 | # now communicate with rxvt |
398 | my $slave = $pty->slave; |
401 | my $slave = $pty->slave; |
399 | while (<$slave>) { print $slave "got <$_>\n" } |
402 | while (<$slave>) { print $slave "got <$_>\n" } |
400 | |
403 | |
401 | -pe *string* |
404 | -pe *string* |
402 | Colon-separated list of perl extension scripts to use in this |
405 | Comma-separated list of perl extension scripts to use (or not to |
403 | terminal instance. See resource perl-ext. |
406 | use) in this terminal instance. See resource perl-ext for details. |
404 | |
407 | |
405 | RESOURCES (available also as long-options) |
408 | RESOURCES (available also as long-options) |
406 | Note: `rxvt --help' gives a list of all resources (long options) |
409 | Note: `rxvt --help' gives a list of all resources (long options) |
407 | compiled into your version. |
410 | compiled into your version. |
408 | |
411 | |
409 | There are two different methods that rxvt can use to get the Xresource |
|
|
410 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
411 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
412 | XGetDefaults), you can set and change the resources using X11 tools like |
412 | You can set and change the resources using X11 tools like xrdb. Many |
413 | xrdb. Many distribution do also load settings from the ~/.Xresources |
413 | distribution do also load settings from the ~/.Xresources file when X |
414 | file when X starts. rxvt will consult the following files/resources in |
414 | starts. rxvt will consult the following files/resources in order, with |
415 | order, with later settings overwriting earlier ones: |
415 | later settings overwriting earlier ones: |
416 | |
416 | |
417 | 1. system-wide app-defaults file, either locale-dependent OR global |
417 | 1. system-wide app-defaults file, either locale-dependent OR global |
418 | 2. app-defaults file in $XAPPLRESDIR |
418 | 2. app-defaults file in $XAPPLRESDIR |
419 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
419 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
420 | 4. SCREEN_RESOURCES for the current screen |
420 | 4. SCREEN_RESOURCES for the current screen |
421 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
421 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
422 | |
422 | |
423 | If compiled with internal Xresources support (i.e. rxvt -h lists |
423 | Note that when reading X resources, rxvt recognizes two class names: |
424 | .Xdefaults) then rxvt accepts application defaults set in |
424 | Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt |
425 | XAPPLOADDIR/URxvt (compile-time defined: usually |
425 | and the original *rxvt* to be easily configured, while the class name |
426 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
426 | URxvt allows resources unique to rxvt, to be shared between different |
427 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
|
|
428 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
|
|
429 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
|
|
430 | to be easily configured, while the class name URxvt allows resources |
|
|
431 | unique to rxvt, notably colours and key-handling, to be shared between |
|
|
432 | different rxvt configurations. If no resources are specified, suitable |
427 | rxvt configurations. If no resources are specified, suitable defaults |
433 | defaults will be used. Command-line arguments can be used to override |
428 | will be used. Command-line arguments can be used to override resource |
434 | resource settings. The following resources are allowed: |
429 | settings. The following resources are supported (you might want to check |
|
|
430 | the rxvtperl(3) manpage for additional settings by perl extensions not |
|
|
431 | documented here): |
435 | |
432 | |
436 | geometry: *geom* |
433 | geometry: *geom* |
437 | Create the window with the specified X window geometry [default |
434 | Create the window with the specified X window geometry [default |
438 | 80x24]; option -geometry. |
435 | 80x24]; option -geometry. |
439 | |
436 | |
… | |
… | |
539 | scale of 1 displays the image without any scaling. A scale of 2 to 9 |
536 | scale of 1 displays the image without any scaling. A scale of 2 to 9 |
540 | specifies an integer number of images in that direction. No image |
537 | specifies an integer number of images in that direction. No image |
541 | will be magnified beyond 10 times its original size. The maximum |
538 | will be magnified beyond 10 times its original size. The maximum |
542 | permitted scale is 1000. [default 0x0+50+50] |
539 | permitted scale is 1000. [default 0x0+50+50] |
543 | |
540 | |
544 | menu: *file[;tag]* |
|
|
545 | Read in the specified menu file (note the `.menu' extension is |
|
|
546 | optional) and also optionally specify a starting tag to find. See |
|
|
547 | the reference documentation for details on the syntax for the |
|
|
548 | menuBar. |
|
|
549 | |
|
|
550 | path: *path* |
541 | path: *path* |
551 | Specify the colon-delimited search path for finding files (XPM and |
542 | Specify the colon-delimited search path for finding XPM files. |
552 | menus), in addition to the paths specified by the RXVTPATH and PATH |
|
|
553 | environment variables. |
|
|
554 | |
543 | |
555 | font: *fontlist* |
544 | font: *fontlist* |
556 | Select the fonts to be used. This is a comma separated list of font |
545 | Select the fonts to be used. This is a comma separated list of font |
557 | names that are used in turn when trying to display Unicode |
546 | names that are checked in order when trying to find glyphs for |
558 | characters. The first font defines the cell size for characters; |
547 | characters. The first font defines the cell size for characters; |
559 | other fonts might be smaller, but not larger. A reasonable default |
548 | other fonts might be smaller, but not (in general) larger. A |
560 | font list is always appended to it; option -fn. |
549 | (hopefully) reasonable default font list is always appended to it; |
|
|
550 | option -fn. |
561 | |
551 | |
562 | Each font can either be a standard X11 core font (XLFD) name, with |
552 | Each font can either be a standard X11 core font (XLFD) name, with |
563 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
553 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
564 | "xft:". |
554 | "xft:". |
565 | |
555 | |
… | |
… | |
568 | available hint currently is "codeset=codeset-name", and this is only |
558 | available hint currently is "codeset=codeset-name", and this is only |
569 | used for Xft fonts. |
559 | used for Xft fonts. |
570 | |
560 | |
571 | For example, this font resource |
561 | For example, this font resource |
572 | |
562 | |
573 | URxvt*font: 9x15bold,\ |
563 | URxvt.font: 9x15bold,\ |
574 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
564 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
575 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
565 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
576 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
566 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
577 | xft:Code2000:antialias=false |
567 | xft:Code2000:antialias=false |
578 | |
568 | |
… | |
… | |
664 | |
654 | |
665 | The string will be interpreted as if typed into the shell as-is. |
655 | The string will be interpreted as if typed into the shell as-is. |
666 | |
656 | |
667 | Example: |
657 | Example: |
668 | |
658 | |
669 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
659 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
670 | |
660 | |
671 | This creates a new file in your home directory with the screen |
661 | This creates a new file in your home directory with the screen |
672 | contents everytime you hit "Print". |
662 | contents everytime you hit "Print". |
673 | |
663 | |
674 | scrollBar: *boolean* |
664 | scrollBar: *boolean* |
… | |
… | |
817 | xterm, have these sequences enabled by default, which doesn't make |
807 | xterm, have these sequences enabled by default, which doesn't make |
818 | it safer, though). |
808 | it safer, though). |
819 | |
809 | |
820 | You can enable them by setting this boolean resource or specifying |
810 | You can enable them by setting this boolean resource or specifying |
821 | -insecure as an option. At the moment, this enables display-answer, |
811 | -insecure as an option. At the moment, this enables display-answer, |
822 | locale, findfont, icon label and window title requests as well as |
812 | locale, findfont, icon label and window title requests. |
823 | dynamic menubar dispatch. |
|
|
824 | |
813 | |
825 | modifier: *modifier* |
814 | modifier: *modifier* |
826 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
815 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
827 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
816 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
828 | |
817 | |
… | |
… | |
871 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
860 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
872 | "\000": octal number) or verbatim control characters ("^?": delete, |
861 | "\000": octal number) or verbatim control characters ("^?": delete, |
873 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
862 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
874 | it can start or end with whitespace. |
863 | it can start or end with whitespace. |
875 | |
864 | |
876 | Please note that you need to double the "\" when using |
865 | Please note that you need to double the "\" in resource files, as |
877 | "--enable-xgetdefault", as X itself does it's own de-escaping (you |
866 | Xlib itself does it's own de-escaping (you can use "\033" instead of |
878 | can use "\033" instead of "\e" (and so on), which will work with |
867 | "\e" (and so on), which will work with both Xt and rxvt's own |
879 | both Xt and rxvt's own processing). |
868 | processing). |
880 | |
869 | |
881 | You can define a range of keysyms in one shot by providing a |
870 | You can define a range of keysyms in one shot by providing a |
882 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
871 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
883 | `/' should be a character not used by the strings. |
872 | `/' should be a character not used by the strings. |
884 | |
873 | |
… | |
… | |
938 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
927 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
939 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
928 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
940 | |
929 | |
941 | perl-ext-common: *string* |
930 | perl-ext-common: *string* |
942 | perl-ext: *string* |
931 | perl-ext: *string* |
943 | Colon-separated list(s) of perl extension scripts to use in this |
932 | Comma-separated list(s) of perl extension scripts (default: |
944 | terminal instance. Each extension is looked up in the library |
933 | "default") to use in this terminal instance; option -pe. |
|
|
934 | |
|
|
935 | Extension names can be prefixed with a "-" sign to prohibit using |
|
|
936 | them. This can be useful to selectively disable some extensions |
|
|
937 | loaded by default, or specified via the "perl-ext-common" resource. |
|
|
938 | For example, "default,-selection" will use all the default extension |
|
|
939 | except "selection". |
|
|
940 | |
|
|
941 | Extension names can also be followed by an argument in angle |
|
|
942 | brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey |
|
|
943 | for searchable scorllback to Alt/Meta-s). Mentioning the same |
|
|
944 | extension multiple times with different arguments will pass multiple |
|
|
945 | arguments to the extension. |
|
|
946 | |
|
|
947 | Each extension is looked up in the library directories, loaded if |
945 | directories, loaded if necessary, and bound to the current terminal |
948 | necessary, and bound to the current terminal instance. |
946 | instance. If this resource is empty or missing, then the perl |
949 | |
|
|
950 | If both of these resources are the empty string, then the perl |
947 | interpreter will not be initialized. The idea behind two options is |
951 | interpreter will not be initialized. The idea behind two options is |
948 | that perl-ext-common will be used for extensions that should be |
952 | that perl-ext-common will be used for extensions that should be |
949 | available to all instances, while perl-ext is used for specific |
953 | available to all instances, while perl-ext is used for specific |
950 | instances; option -pe. |
954 | instances. |
951 | |
955 | |
952 | perl-eval: *string* |
956 | perl-eval: *string* |
953 | Perl code to be evaluated when all extensions have been registered. |
957 | Perl code to be evaluated when all extensions have been registered. |
954 | See the rxvtperl(3) manpage. |
958 | See the rxvtperl(3) manpage. Due to security reasons, this resource |
|
|
959 | will be ignored when running setuid/setgid. |
955 | |
960 | |
956 | perl-lib: *path* |
961 | perl-lib: *path* |
957 | Colon-separated list of additional directories that hold extension |
962 | Colon-separated list of additional directories that hold extension |
958 | scripts. When looking for extensions specified by the "perl" |
963 | scripts. When looking for extensions specified by the "perl" |
959 | resource, rxvt will first look in these directories and then in |
964 | resource, rxvt will first look in these directories and then in |
960 | /opt/rxvt/lib/urxvt/perl/. |
965 | /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
966 | will be ignored when running setuid/setgid. |
961 | |
967 | |
962 | See the rxvtperl(3) manpage. |
968 | See the rxvtperl(3) manpage. |
|
|
969 | |
|
|
970 | selection.pattern-*idx*: *perl-regex* |
|
|
971 | Additional selection patterns, see the rxvtperl(3) manpage for |
|
|
972 | details. |
|
|
973 | |
|
|
974 | selection-autotransform.*idx*: *perl-transform* |
|
|
975 | Selection auto-transform patterns, see the rxvtperl(3) manpage for |
|
|
976 | details. |
|
|
977 | |
|
|
978 | searchable-scrollback: *keysym* |
|
|
979 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
980 | (default: "M-s"). |
|
|
981 | |
|
|
982 | urlLauncher: *string* |
|
|
983 | Specifies the program to be started with a URL argument. Used by the |
|
|
984 | "selection-popup" and "mark-urls" perl extensions. |
|
|
985 | |
|
|
986 | transient-for: *windowid* |
|
|
987 | Sets the WM_TRANSIENT_FOR property to the given window iw. |
963 | |
988 | |
964 | THE SCROLLBAR |
989 | THE SCROLLBAR |
965 | Lines of text that scroll off the top of the rxvt window (resource: |
990 | Lines of text that scroll off the top of the rxvt window (resource: |
966 | saveLines) and can be scrolled back using the scrollbar or by |
991 | saveLines) and can be scrolled back using the scrollbar or by |
967 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
992 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
… | |
… | |
1007 | |
1032 | |
1008 | CHANGING FONTS |
1033 | CHANGING FONTS |
1009 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1034 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1010 | supported in rxvt-unicode. Bug me if you need this. |
1035 | supported in rxvt-unicode. Bug me if you need this. |
1011 | |
1036 | |
1012 | You can, however, switch fonts at runtime using escape sequences (and |
1037 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
1013 | therefore using the menubar), e.g.: |
|
|
1014 | |
1038 | |
1015 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1039 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1040 | |
|
|
1041 | You can use keyboard shortcuts, too: |
|
|
1042 | |
|
|
1043 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1044 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1016 | |
1045 | |
1017 | rxvt-unicode will automatically re-apply these fonts to the output so |
1046 | rxvt-unicode will automatically re-apply these fonts to the output so |
1018 | far. |
1047 | far. |
1019 | |
1048 | |
1020 | ISO 14755 SUPPORT |
1049 | ISO 14755 SUPPORT |
… | |
… | |
1156 | display in it's child processes. |
1185 | display in it's child processes. |
1157 | |
1186 | |
1158 | SHELL |
1187 | SHELL |
1159 | The shell to be used for command execution, defaults to "/bin/sh". |
1188 | The shell to be used for command execution, defaults to "/bin/sh". |
1160 | |
1189 | |
1161 | RXVTPATH |
|
|
1162 | The path where rxvt looks for support files such as menu and xpm |
|
|
1163 | files. |
|
|
1164 | |
|
|
1165 | PATH |
|
|
1166 | Used in the same way as "RXVTPATH". |
|
|
1167 | |
|
|
1168 | RXVT_SOCKET |
1190 | RXVT_SOCKET |
1169 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1191 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1170 | |
1192 | |
1171 | Default $HOME/.rxvt-unicode-*<nodename*. |
1193 | Default $HOME/.rxvt-unicode-*<nodename*. |
1172 | |
1194 | |