… | |
… | |
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.2, 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 | |
… | |
… | |
163 | |
163 | |
164 | See also the question "How does rxvt-unicode choose fonts?" in the |
164 | See also the question "How does rxvt-unicode choose fonts?" in the |
165 | FAQ section of rxvt(7). |
165 | FAQ section of rxvt(7). |
166 | |
166 | |
167 | -fb *fontlist* |
167 | -fb *fontlist* |
168 | Compile font-styles: The bold font list to use when bold characters |
168 | Compile *font-styles*: The bold font list to use when bold |
169 | are to be printed. See resource boldFont for details. |
169 | characters are to be printed. See resource boldFont for details. |
170 | |
170 | |
171 | -fi *fontlist* |
171 | -fi *fontlist* |
172 | Compile font-styles: The italic font list to use when bold |
172 | Compile *font-styles*: The italic font list to use when *italic* |
173 | characters are to be printed. See resource italicFont for details. |
173 | characters are to be printed. See resource italicFont for details. |
174 | |
174 | |
175 | -fbi *fontlist* |
175 | -fbi *fontlist* |
176 | Compile font-styles: The bold italic font list to use when bold |
176 | Compile *font-styles*: The bold italic font list to use when *bold |
177 | characters are to be printed. See resource boldItalicFont for |
177 | italic* characters are to be printed. See resource boldItalicFont |
178 | details. |
178 | for details. |
179 | |
179 | |
180 | -is|+is |
180 | -is|+is |
181 | Compile font-styles: Bold/Italic font styles imply high intensity |
181 | Compile *font-styles*: Bold/Italic font styles imply high intensity |
182 | foreground/background (default). See resource intensityStyles for |
182 | foreground/background (default). See resource intensityStyles for |
183 | details. |
183 | details. |
184 | |
184 | |
185 | -name *name* |
185 | -name *name* |
186 | Specify the application name under which resources are to be |
186 | Specify the application name under which resources are to be |
… | |
… | |
251 | externalBorder. |
251 | externalBorder. |
252 | |
252 | |
253 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
253 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
254 | if honoured by the WM, the rxvt-unicode window will not have window |
254 | if honoured by the WM, the rxvt-unicode window will not have window |
255 | decorations; resource borderLess. |
255 | decorations; resource borderLess. |
|
|
256 | |
|
|
257 | -sbg |
|
|
258 | Compile *frills*: Disable the usage of the built-in block |
|
|
259 | graphics/line drawing characters and just rely on what the specified |
|
|
260 | fonts provide. Use this if you have a good font and want to use its |
|
|
261 | block graphic glyphs; resource skipBuiltinGlyphs. |
256 | |
262 | |
257 | -lsp *number* |
263 | -lsp *number* |
258 | Compile *frills*: Lines (pixel height) to insert between each row of |
264 | Compile *frills*: Lines (pixel height) to insert between each row of |
259 | the display. Useful to work around font rendering problems; resource |
265 | the display. Useful to work around font rendering problems; resource |
260 | linespace. |
266 | linespace. |
… | |
… | |
365 | $rxvt->signal_connect_after (realize => sub { |
371 | $rxvt->signal_connect_after (realize => sub { |
366 | my $xid = $_[0]->window->get_xid; |
372 | my $xid = $_[0]->window->get_xid; |
367 | system "rxvt -embed $xid &"; |
373 | system "rxvt -embed $xid &"; |
368 | }); |
374 | }); |
369 | |
375 | |
370 | -pty-fd *fileno* |
376 | -pty-fd *file descriptor* |
371 | 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 |
372 | 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 |
373 | 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 |
374 | without having to run a program within it. |
380 | without having to run a program within it. |
375 | |
381 | |
376 | 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 |
377 | 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 |
378 | yourself if you want that. |
384 | yourself if you want that. |
379 | |
385 | |
|
|
386 | As an extremely special case, specifying -1 will completely suppress |
|
|
387 | pty/tty operations. |
|
|
388 | |
380 | 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 |
381 | used (a longer example is in doc/pty-fd): |
390 | used (a longer example is in doc/pty-fd): |
382 | |
391 | |
383 | use IO::Pty; |
392 | use IO::Pty; |
384 | use Fcntl; |
393 | use Fcntl; |
… | |
… | |
390 | |
399 | |
391 | # now communicate with rxvt |
400 | # now communicate with rxvt |
392 | my $slave = $pty->slave; |
401 | my $slave = $pty->slave; |
393 | while (<$slave>) { print $slave "got <$_>\n" } |
402 | while (<$slave>) { print $slave "got <$_>\n" } |
394 | |
403 | |
|
|
404 | -pe *string* |
|
|
405 | Comma-separated list of perl extension scripts to use (or not to |
|
|
406 | use) in this terminal instance. See resource perl-ext for details. |
|
|
407 | |
395 | RESOURCES (available also as long-options) |
408 | RESOURCES (available also as long-options) |
396 | Note: `rxvt --help' gives a list of all resources (long options) |
409 | Note: `rxvt --help' gives a list of all resources (long options) |
397 | compiled into your version. |
410 | compiled into your version. |
398 | |
411 | |
399 | There are two different methods that rxvt can use to get the Xresource |
|
|
400 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
401 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
402 | 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 |
403 | xrdb. Many distribution do also load settings from the ~/.Xresources |
413 | distribution do also load settings from the ~/.Xresources file when X |
404 | file when X starts. rxvt will consult the following files/resources in |
414 | starts. rxvt will consult the following files/resources in order, with |
405 | order, with later settings overwriting earlier ones: |
415 | later settings overwriting earlier ones: |
406 | |
416 | |
407 | 1. system-wide app-defaults file, either locale-dependent OR global |
417 | 1. system-wide app-defaults file, either locale-dependent OR global |
408 | 2. app-defaults file in $XAPPLRESDIR |
418 | 2. app-defaults file in $XAPPLRESDIR |
409 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
419 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
410 | 4. SCREEN_RESOURCES for the current screen |
420 | 4. SCREEN_RESOURCES for the current screen |
411 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
421 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
412 | |
422 | |
413 | If compiled with internal Xresources support (i.e. rxvt -h lists |
423 | Note that when reading X resources, rxvt recognizes two class names: |
414 | .Xdefaults) then rxvt accepts application defaults set in |
424 | Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt |
415 | XAPPLOADDIR/URxvt (compile-time defined: usually |
425 | and the original *rxvt* to be easily configured, while the class name |
416 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
426 | URxvt allows resources unique to rxvt, to be shared between different |
417 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
|
|
418 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
|
|
419 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
|
|
420 | to be easily configured, while the class name URxvt allows resources |
|
|
421 | unique to rxvt, notably colours and key-handling, to be shared between |
|
|
422 | different rxvt configurations. If no resources are specified, suitable |
427 | rxvt configurations. If no resources are specified, suitable defaults |
423 | 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 |
424 | 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): |
425 | |
432 | |
426 | geometry: *geom* |
433 | geometry: *geom* |
427 | Create the window with the specified X window geometry [default |
434 | Create the window with the specified X window geometry [default |
428 | 80x24]; option -geometry. |
435 | 80x24]; option -geometry. |
429 | |
436 | |
… | |
… | |
545 | font: *fontlist* |
552 | font: *fontlist* |
546 | Select the fonts to be used. This is a comma separated list of font |
553 | Select the fonts to be used. This is a comma separated list of font |
547 | names that are used in turn when trying to display Unicode |
554 | names that are used in turn when trying to display Unicode |
548 | characters. The first font defines the cell size for characters; |
555 | characters. The first font defines the cell size for characters; |
549 | other fonts might be smaller, but not larger. A reasonable default |
556 | other fonts might be smaller, but not larger. A reasonable default |
550 | font list is always appended to it. option -fn. |
557 | font list is always appended to it; option -fn. |
551 | |
558 | |
552 | Each font can either be a standard X11 core font (XLFD) name, with |
559 | Each font can either be a standard X11 core font (XLFD) name, with |
553 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
560 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
554 | "xft:". |
561 | "xft:". |
555 | |
562 | |
… | |
… | |
707 | borderLess: *boolean* |
714 | borderLess: *boolean* |
708 | Set MWM hints to request a borderless window, i.e. if honoured by |
715 | Set MWM hints to request a borderless window, i.e. if honoured by |
709 | the WM, the rxvt-unicode window will not have window decorations; |
716 | the WM, the rxvt-unicode window will not have window decorations; |
710 | option -bl. |
717 | option -bl. |
711 | |
718 | |
|
|
719 | skipBuiltinGlyphs: *boolean* |
|
|
720 | Compile *frills*: Disable the usage of the built-in block |
|
|
721 | graphics/line drawing characters and just rely on what the specified |
|
|
722 | fonts provide. Use this if you have a good font and want to use its |
|
|
723 | block graphic glyphs; option -sbg. |
|
|
724 | |
712 | termName: *termname* |
725 | termName: *termname* |
713 | Specifies the terminal type name to be set in the TERM environment |
726 | Specifies the terminal type name to be set in the TERM environment |
714 | variable; option -tn. |
727 | variable; option -tn. |
715 | |
728 | |
716 | linespace: *number* |
729 | linespace: *number* |
… | |
… | |
774 | |
787 | |
775 | imLocale: *name* |
788 | imLocale: *name* |
776 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
789 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
777 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
790 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
778 | the input extension to be able to input japanese characters while |
791 | the input extension to be able to input japanese characters while |
779 | staying in another locale. option -imlocale. |
792 | staying in another locale; option -imlocale. |
780 | |
793 | |
781 | imFont: *fontset* |
794 | imFont: *fontset* |
782 | Specify the font-set used for XIM styles "OverTheSpot" or |
795 | Specify the font-set used for XIM styles "OverTheSpot" or |
783 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
796 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
784 | separated by commas), i.e. it's not in the same format as the other |
797 | separated by commas), i.e. it's not in the same format as the other |
… | |
… | |
787 | to the base font. option -imfont. |
800 | to the base font. option -imfont. |
788 | |
801 | |
789 | tripleclickwords: *boolean* |
802 | tripleclickwords: *boolean* |
790 | Change the meaning of triple-click selection with the left mouse |
803 | Change the meaning of triple-click selection with the left mouse |
791 | button. Instead of selecting a full line it will extend the |
804 | button. Instead of selecting a full line it will extend the |
792 | selection to the end of the logical line only. option -tcw. |
805 | selection to the end of the logical line only; option -tcw. |
793 | |
806 | |
794 | insecure: *boolean* |
807 | insecure: *boolean* |
795 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
808 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
796 | that echo arbitrary strings like the icon name or the locale. This |
809 | that echo arbitrary strings like the icon name or the locale. This |
797 | could be abused if somebody gets 8-bit-clean access to your display, |
810 | could be abused if somebody gets 8-bit-clean access to your display, |
… | |
… | |
855 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
868 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
856 | "\000": octal number) or verbatim control characters ("^?": delete, |
869 | "\000": octal number) or verbatim control characters ("^?": delete, |
857 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
870 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
858 | it can start or end with whitespace. |
871 | it can start or end with whitespace. |
859 | |
872 | |
860 | Please note that you need to double the "\" when using |
873 | Please note that you need to double the "\" in resource files, as |
861 | "--enable-xgetdefault", as X itself does it's own de-escaping (you |
874 | Xlib itself does it's own de-escaping (you can use "\033" instead of |
862 | can use "\033" instead of "\e" (and so on), which will work with |
875 | "\e" (and so on), which will work with both Xt and rxvt's own |
863 | both Xt and rxvt's own processing). |
876 | processing). |
864 | |
877 | |
865 | You can define a range of keysyms in one shot by providing a |
878 | You can define a range of keysyms in one shot by providing a |
866 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
879 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
867 | `/' should be a character not used by the strings. |
880 | `/' should be a character not used by the strings. |
868 | |
881 | |
… | |
… | |
880 | is interpreted and executed as rxvt's control sequence. For example |
893 | is interpreted and executed as rxvt's control sequence. For example |
881 | the following means "change the current locale to "zh_CN.GBK" when |
894 | the following means "change the current locale to "zh_CN.GBK" when |
882 | Control-Meta-c is being pressed": |
895 | Control-Meta-c is being pressed": |
883 | |
896 | |
884 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
897 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
898 | |
|
|
899 | If *string* takes the form "perl:STRING", then the specified STRING |
|
|
900 | is passed to the "on_keyboard_command" perl handler. See the |
|
|
901 | rxvtperl(3) manpage. For example, the selection extension (activated |
|
|
902 | via "rxvt -pe selection") listens for "selection:rot13" events: |
|
|
903 | |
|
|
904 | URxvt.keysym.M-C-c: perl:selection:rot13 |
885 | |
905 | |
886 | Due the the large number of modifier combinations, a defined key |
906 | Due the the large number of modifier combinations, a defined key |
887 | mapping will match if at *at least* the specified identifiers are |
907 | mapping will match if at *at least* the specified identifiers are |
888 | being set, and no other key mappings with those and more bits are |
908 | being set, and no other key mappings with those and more bits are |
889 | being defined. That means that defining a key map for "a" will |
909 | being defined. That means that defining a key map for "a" will |
… | |
… | |
912 | Other things are possible, e.g. resizing (see rxvt(7) for more |
932 | Other things are possible, e.g. resizing (see rxvt(7) for more |
913 | info): |
933 | info): |
914 | |
934 | |
915 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
935 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
916 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
936 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
937 | |
|
|
938 | perl-ext-common: *string* |
|
|
939 | perl-ext: *string* |
|
|
940 | Comma-separated list(s) of perl extension scripts (default: |
|
|
941 | "default") to use in this terminal instance; option -pe. |
|
|
942 | |
|
|
943 | Extension names can be prefixed with a "-" sign to prohibit using |
|
|
944 | them. This can be useful to selectively disable some extensions |
|
|
945 | loaded by default, or specified via the "perl-ext-common" resource. |
|
|
946 | For example, "default,-selection" will use all the default extension |
|
|
947 | except "selection". |
|
|
948 | |
|
|
949 | Extension names can also be followed by an argument in angle |
|
|
950 | brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey |
|
|
951 | for searchable scorllback to Alt/Meta-s). Mentioning the same |
|
|
952 | extension multiple times with different arguments will pass multiple |
|
|
953 | arguments to the extension. |
|
|
954 | |
|
|
955 | Each extension is looked up in the library directories, loaded if |
|
|
956 | necessary, and bound to the current terminal instance. |
|
|
957 | |
|
|
958 | If both of these resources are the empty string, then the perl |
|
|
959 | interpreter will not be initialized. The idea behind two options is |
|
|
960 | that perl-ext-common will be used for extensions that should be |
|
|
961 | available to all instances, while perl-ext is used for specific |
|
|
962 | instances. |
|
|
963 | |
|
|
964 | perl-eval: *string* |
|
|
965 | Perl code to be evaluated when all extensions have been registered. |
|
|
966 | See the rxvtperl(3) manpage. Due to security reasons, this resource |
|
|
967 | will be ignored when running setuid/setgid. |
|
|
968 | |
|
|
969 | perl-lib: *path* |
|
|
970 | Colon-separated list of additional directories that hold extension |
|
|
971 | scripts. When looking for extensions specified by the "perl" |
|
|
972 | resource, rxvt will first look in these directories and then in |
|
|
973 | /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
974 | will be ignored when running setuid/setgid. |
|
|
975 | |
|
|
976 | See the rxvtperl(3) manpage. |
|
|
977 | |
|
|
978 | selection.pattern-*idx*: *perl-regex* |
|
|
979 | Additional selection patterns, see the rxvtperl(3) manpage for |
|
|
980 | details. |
|
|
981 | |
|
|
982 | selection-autotransform.*idx*: *perl-transform* |
|
|
983 | Selection auto-transform patterns, see the rxvtperl(3) manpage for |
|
|
984 | details. |
|
|
985 | |
|
|
986 | searchable-scrollback: *keysym* |
|
|
987 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
988 | (default: "M-s"). |
|
|
989 | |
|
|
990 | urlLauncher: *string* |
|
|
991 | Specifies the program to be started with a URL argument. Used by the |
|
|
992 | "selection-popup" and "mark-urls" perl extensions. |
|
|
993 | |
|
|
994 | transient-for: *windowid* |
|
|
995 | Sets the WM_TRANSIENT_FOR property to the given window iw. |
917 | |
996 | |
918 | THE SCROLLBAR |
997 | THE SCROLLBAR |
919 | Lines of text that scroll off the top of the rxvt window (resource: |
998 | Lines of text that scroll off the top of the rxvt window (resource: |
920 | saveLines) and can be scrolled back using the scrollbar or by |
999 | saveLines) and can be scrolled back using the scrollbar or by |
921 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
1000 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |