… | |
… | |
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 4.9, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 5.5, 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 | |
15 | FREQUENTLY ASKED QUESTIONS |
15 | FREQUENTLY ASKED QUESTIONS |
16 | See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions |
16 | See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions |
17 | and answer to them and some common problems. |
17 | and answer to them and some common problems. That document is also |
|
|
18 | accessible on the World-Wide-Web at |
|
|
19 | <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
18 | |
20 | |
19 | RXVT-UNICODE VS. RXVT |
21 | RXVT-UNICODE VS. RXVT |
20 | Unlike the original rxvt, rxvt-unicode stores all text in Unicode |
22 | Unlike the original rxvt, rxvt-unicode stores all text in Unicode |
21 | internally. That means it can store and display most scripts in the |
23 | internally. That means it can store and display most scripts in the |
22 | world. Being a terminal emulator, however, some things are very |
24 | world. Being a terminal emulator, however, some things are very |
… | |
… | |
309 | |
311 | |
310 | -ssr|+ssr |
312 | -ssr|+ssr |
311 | Turn on/off secondary screen scroll (default enabled); resource |
313 | Turn on/off secondary screen scroll (default enabled); resource |
312 | secondaryScroll. |
314 | secondaryScroll. |
313 | |
315 | |
314 | -xrm *resourcestring* |
316 | -keysym.*sym* *string* |
315 | No effect on rxvt-unicode. Simply passes through an argument to be |
317 | Remap a key symbol. See resource keysym. |
316 | made available in the instance's argument list. Appears in |
318 | |
317 | *WM_COMMAND* in some window managers. |
319 | -embed *windowid* |
|
|
320 | Tells rxvt to embed it's windows into an already-existing window, |
|
|
321 | which enables applications to easily embed a terminal. |
|
|
322 | |
|
|
323 | Right now, rxvt will first unmap/map the specified window, so it |
|
|
324 | shouldn't be a top-level window. rxvt will also reconfigure it quite |
|
|
325 | a bit, so don't expect it to keep some specific state. It's best to |
|
|
326 | create an extra subwindow for rxvt and leave it alone. |
|
|
327 | |
|
|
328 | The window will not be destroyed when rxvt exits. |
|
|
329 | |
|
|
330 | It might be useful to know that rxvt will not close file descriptors |
|
|
331 | passed to it (except for stdin/out/err, of course), so you can use |
|
|
332 | file descriptors to communicate with the programs within the |
|
|
333 | terminal. This works regardless of wether the "-embed" option was |
|
|
334 | used or not. |
|
|
335 | |
|
|
336 | Here is a short Gtk2-perl snippet that illustrates how this option |
|
|
337 | can be used (a longer example is in doc/embed): |
|
|
338 | |
|
|
339 | my $rxvt = new Gtk2::Socket; |
|
|
340 | $rxvt->signal_connect_after (realize => sub { |
|
|
341 | my $xid = $_[0]->window->get_xid; |
|
|
342 | system "rxvt -embed $xid &"; |
|
|
343 | }); |
|
|
344 | |
|
|
345 | -pty-fd *fileno* |
|
|
346 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
|
|
347 | but instead use the given filehandle as the tty master. This is |
|
|
348 | useful if you want to drive rxvt as a generic terminal emulator |
|
|
349 | without having to run a program within it. |
|
|
350 | |
|
|
351 | If this switch is given, rxvt will not create any utmp/wtmp entries |
|
|
352 | and will not tinker with pty/tty permissions - you have to do that |
|
|
353 | yourself if you want that. |
|
|
354 | |
|
|
355 | Here is a example in perl that illustrates how this option can be |
|
|
356 | used (a longer example is in doc/pty-fd): |
|
|
357 | |
|
|
358 | use IO::Pty; |
|
|
359 | use Fcntl; |
|
|
360 | |
|
|
361 | my $pty = new IO::Pty; |
|
|
362 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
363 | system "rxvt -pty-fd " . (fileno $pty) . "&"; |
|
|
364 | close $pty; |
|
|
365 | |
|
|
366 | # now communicate with rxvt |
|
|
367 | my $slave = $pty->slave; |
|
|
368 | while (<$slave>) { print $slave "got <$_>\n" } |
318 | |
369 | |
319 | RESOURCES (available also as long-options) |
370 | RESOURCES (available also as long-options) |
320 | Note: `rxvt --help' gives a list of all resources (long options) |
371 | Note: `rxvt --help' gives a list of all resources (long options) |
321 | compiled into your version. |
372 | compiled into your version. |
322 | |
373 | |
323 | There are two different methods that rxvt can use to get the Xresource |
374 | There are two different methods that rxvt can use to get the Xresource |
324 | data: using the X libraries (Xrm*-functions) or internal Xresources |
375 | data: using the X libraries (Xrm*-functions) or internal Xresources |
325 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
376 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
326 | XGetDefaults), you can set and change the resources using X11 tools like |
377 | XGetDefaults), you can set and change the resources using X11 tools like |
327 | xset. Many distribution do also load settings from the ~/.Xresources |
378 | xrdb. Many distribution do also load settings from the ~/.Xresources |
328 | file when X starts. |
379 | file when X starts. rxvt will consult the following files/resources in |
|
|
380 | order, with later settings overwriting earlier ones: |
|
|
381 | |
|
|
382 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
383 | 2. app-defaults file in $XAPPLRESDIR |
|
|
384 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
|
|
385 | 4. SCREEN_RESOURCES for the current screen |
|
|
386 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
329 | |
387 | |
330 | If compiled with internal Xresources support (i.e. rxvt -h lists |
388 | If compiled with internal Xresources support (i.e. rxvt -h lists |
331 | .Xdefaults) then rxvt accepts application defaults set in |
389 | .Xdefaults) then rxvt accepts application defaults set in |
332 | XAPPLOADDIR/URxvt (compile-time defined: usually |
390 | XAPPLOADDIR/URxvt (compile-time defined: usually |
333 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
391 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
… | |
… | |
576 | True: scroll to bottom when tty receives output; option -si. False: |
634 | True: scroll to bottom when tty receives output; option -si. False: |
577 | do not scroll to bottom when tty receives output; option +si. |
635 | do not scroll to bottom when tty receives output; option +si. |
578 | |
636 | |
579 | scrollWithBuffer: *boolean* |
637 | scrollWithBuffer: *boolean* |
580 | True: scroll with scrollback buffer when tty receives new lines (and |
638 | True: scroll with scrollback buffer when tty receives new lines (and |
581 | scrollTtyOutput is False); option +sw. False: do not scroll with |
639 | scrollTtyOutput is False); option -sw. False: do not scroll with |
582 | scrollback buffer when tty recieves new lines; option -sw. |
640 | scrollback buffer when tty recieves new lines; option +sw. |
583 | |
641 | |
584 | scrollTtyKeypress: *boolean* |
642 | scrollTtyKeypress: *boolean* |
585 | True: scroll to bottom when a non-special key is pressed. Special |
643 | True: scroll to bottom when a non-special key is pressed. Special |
586 | keys are those which are intercepted by rxvt-unicode for special |
644 | keys are those which are intercepted by rxvt-unicode for special |
587 | handling and are not passed onto the shell; option -sk. False: do |
645 | handling and are not passed onto the shell; option -sk. False: do |
… | |
… | |
639 | pointerColor2: *colour* |
697 | pointerColor2: *colour* |
640 | Mouse pointer background colour. |
698 | Mouse pointer background colour. |
641 | |
699 | |
642 | pointerBlankDelay: *number* |
700 | pointerBlankDelay: *number* |
643 | Specifies number of seconds before blanking the pointer [default 2]. |
701 | Specifies number of seconds before blanking the pointer [default 2]. |
|
|
702 | Use a large number (e.g. 987654321) to effectively disable the |
|
|
703 | timeout. |
644 | |
704 | |
645 | backspacekey: *string* |
705 | backspacekey: *string* |
646 | The string to send when the backspace key is pressed. If set to DEC |
706 | The string to send when the backspace key is pressed. If set to DEC |
647 | or unset it will send Delete (code 127) or, if shifted, Backspace |
707 | or unset it will send Delete (code 127) or, if shifted, Backspace |
648 | (code 8) - which can be reversed with the appropriate DEC private |
708 | (code 8) - which can be reversed with the appropriate DEC private |
… | |
… | |
739 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
799 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
740 | "\000": octal number) or verbatim control characters ("^?": delete, |
800 | "\000": octal number) or verbatim control characters ("^?": delete, |
741 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
801 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
742 | it can start or end with whitespace. |
802 | it can start or end with whitespace. |
743 | |
803 | |
|
|
804 | Please note that you need to double the "\" when using |
|
|
805 | "--enable-xgetdefault", as X itself does it's own de-escaping (you |
|
|
806 | can use "\033" instead of "\e" (and so on), which will work with |
|
|
807 | both Xt and rxvt's own processing). |
|
|
808 | |
744 | You can define a range of keysyms in one shot by providing a |
809 | You can define a range of keysyms in one shot by providing a |
745 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
810 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
746 | `/' should be a character not used by the strings. |
811 | `/' should be a character not used by the strings. |
747 | |
812 | |
748 | Its usage can be demonstrated by an example: |
813 | Its usage can be demonstrated by an example: |
749 | |
814 | |
750 | URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> |
815 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
751 | |
816 | |
752 | The above line is equivalent to the following three lines: |
817 | The above line is equivalent to the following three lines: |
753 | |
818 | |
754 | URxvt.keysym.Meta-Control-0x61: \e<M-C-a> |
819 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
755 | URxvt.keysym.Meta-Control-0x62: \e<M-C-b> |
820 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
756 | URxvt.keysym.Meta-Control-0x63: \e<M-C-c> |
821 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
757 | |
822 | |
758 | If *string* takes the form of "proto:STRING", the specified STRING |
823 | If *string* takes the form of "command:STRING", the specified STRING |
759 | is interpreted and executed as rxvt's control sequence. For example |
824 | is interpreted and executed as rxvt's control sequence. For example |
760 | the following means "change the current locale to "zh_CN.GBK" when |
825 | the following means "change the current locale to "zh_CN.GBK" when |
761 | Control-Meta-c is being pressed": |
826 | Control-Meta-c is being pressed": |
762 | |
827 | |
763 | URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 |
828 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
829 | |
|
|
830 | Due the the large number of modifier combinations, a defined key |
|
|
831 | mapping will match if at *at least* the specified identifiers are |
|
|
832 | being set, and no other key mappings with those and more bits are |
|
|
833 | being defined. That means that defining a key map for "a" will |
|
|
834 | automatically provide definitions for "Meta-a", "Shift-a" and so on, |
|
|
835 | unless some of those are defined mappings themselves. |
|
|
836 | |
|
|
837 | Unfortunately, this will override built-in key mappings. For example |
|
|
838 | if you overwrite the "Insert" key you will disable rxvt's |
|
|
839 | "Shift-Insert" mapping. To re-enable that, you can poke "holes" into |
|
|
840 | the user-defined keymap using the "builtin:" replacement: |
|
|
841 | |
|
|
842 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
843 | URxvt.keysym.S-Insert: builtin: |
|
|
844 | |
|
|
845 | The first line defines a mapping for "Insert" and *any* combination |
|
|
846 | of modifiers. The second line re-establishes the default mapping for |
|
|
847 | "Shift-Insert". |
764 | |
848 | |
765 | The following example will map Control-Meta-1 and Control-Meta-2 to |
849 | The following example will map Control-Meta-1 and Control-Meta-2 to |
766 | the fonts "suxuseuro" and "9x15bold", so you cna have some limited |
850 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
767 | font-switching at runtime: |
851 | font-switching at runtime: |
768 | |
852 | |
769 | URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 |
853 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
770 | URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 |
854 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
771 | |
855 | |
772 | "proto:\033]701;zh_CN.GBK\007" means: change the current locale to |
856 | Other things are possible, e.g. resizing (see rxvt(7) for more |
773 | "zh_CN.GBK". |
857 | info): |
|
|
858 | |
|
|
859 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
860 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
774 | |
861 | |
775 | THE SCROLLBAR |
862 | THE SCROLLBAR |
776 | Lines of text that scroll off the top of the rxvt window (resource: |
863 | Lines of text that scroll off the top of the rxvt window (resource: |
777 | saveLines) and can be scrolled back using the scrollbar or by |
864 | saveLines) and can be scrolled back using the scrollbar or by |
778 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
865 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
… | |
… | |
788 | normal text selection/insertion, hold either the Shift or the Meta (Alt) |
875 | normal text selection/insertion, hold either the Shift or the Meta (Alt) |
789 | key while performing the desired mouse action. |
876 | key while performing the desired mouse action. |
790 | |
877 | |
791 | If mouse reporting mode is active, the normal scrollbar actions are |
878 | If mouse reporting mode is active, the normal scrollbar actions are |
792 | disabled -- on the assumption that we are using a fullscreen |
879 | disabled -- on the assumption that we are using a fullscreen |
793 | application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) |
880 | application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ |
794 | and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down |
881 | (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the |
795 | arrows sends ESC[A (Up) and ESC[B (Down), respectively. |
882 | up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. |
796 | |
883 | |
797 | TEXT SELECTION AND INSERTION |
884 | TEXT SELECTION AND INSERTION |
798 | The behaviour of text selection and insertion mechanism is similar to |
885 | The behaviour of text selection and insertion mechanism is similar to |
799 | *xterm*(1). |
886 | *xterm*(1). |
800 | |
887 | |
… | |
… | |
929 | rxvt -fg Black -bg White -rv |
1016 | rxvt -fg Black -bg White -rv |
930 | would yield White on Black, while on *xterm*(1) it would yield Black |
1017 | would yield White on Black, while on *xterm*(1) it would yield Black |
931 | on White. |
1018 | on White. |
932 | |
1019 | |
933 | ENVIRONMENT |
1020 | ENVIRONMENT |
934 | rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The |
1021 | rxvt sets and/or uses the following environment variables: |
935 | environment variable WINDOWID is set to the X window id number of the |
1022 | |
936 | rxvt window and it also uses and sets the environment variable DISPLAY |
1023 | TERM |
937 | to specify which display terminal to use. rxvt uses the environment |
1024 | Normally set to "rxvt-unicode", unless overwritten at configure |
938 | variables RXVTPATH and PATH to find XPM files. |
1025 | time, via resources or on the commandline. |
|
|
1026 | |
|
|
1027 | COLORTERM |
|
|
1028 | Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled |
|
|
1029 | with XPM support, and optionally with the added extension "-mono" to |
|
|
1030 | indicate that rxvt-unicode runs on a monochrome screen. |
|
|
1031 | |
|
|
1032 | COLORFGBG |
|
|
1033 | Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is |
|
|
1034 | the colour code used as default foreground/text colour (or the |
|
|
1035 | string "default" to indicate that the default-colour escape sequence |
|
|
1036 | is to be used), "bg" is the colour code used as default background |
|
|
1037 | colour (or the string "default"), and "xpm" is the string "default" |
|
|
1038 | if rxvt was compiled with XPM support. Libraries like "ncurses" and |
|
|
1039 | "slang" can (and do) use this information to optimize screen output. |
|
|
1040 | |
|
|
1041 | WINDOWID |
|
|
1042 | Set to the (decimal) X Window ID of the rxvt window (the toplevel |
|
|
1043 | window, which usually has subwindows for the scrollbar, the terminal |
|
|
1044 | window and so on). |
|
|
1045 | |
|
|
1046 | TERMINFO |
|
|
1047 | Set to the terminfo directory iff rxvt was configured with |
|
|
1048 | "--with-terminfo=PATH". |
|
|
1049 | |
|
|
1050 | DISPLAY |
|
|
1051 | Used by rxvt to connect to the display and set to the correct |
|
|
1052 | display in it's child processes. |
|
|
1053 | |
|
|
1054 | SHELL |
|
|
1055 | The shell to be used for command execution, defaults to "/bin/sh". |
|
|
1056 | |
|
|
1057 | RXVTPATH |
|
|
1058 | The path where rxvt looks for support files such as menu and xpm |
|
|
1059 | files. |
|
|
1060 | |
|
|
1061 | PATH |
|
|
1062 | Used in the same way as "RXVTPATH". |
|
|
1063 | |
|
|
1064 | RXVT_SOCKET |
|
|
1065 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
|
|
1066 | |
|
|
1067 | Default "$HOME/.rxvt-unicode-<nodename". |
|
|
1068 | |
|
|
1069 | HOME |
|
|
1070 | Used to locate the default directory for the unix domain socket for |
|
|
1071 | daemon communications and to locate various resource files (such as |
|
|
1072 | ".Xdefaults") |
|
|
1073 | |
|
|
1074 | XAPPLRESDIR |
|
|
1075 | Directory where various X resource files are being located. |
|
|
1076 | |
|
|
1077 | XENVIRONMENT |
|
|
1078 | If set and accessible, gives the name of a X resource file to be |
|
|
1079 | loaded by rxvt. |
939 | |
1080 | |
940 | FILES |
1081 | FILES |
941 | /usr/lib/X11/rgb.txt |
1082 | /usr/lib/X11/rgb.txt |
942 | Color names. |
1083 | Color names. |
943 | |
1084 | |
… | |
… | |
951 | |
1092 | |
952 | Click-and-drag doesn't work with X11 mouse report overriding. |
1093 | Click-and-drag doesn't work with X11 mouse report overriding. |
953 | |
1094 | |
954 | CURRENT PROJECT COORDINATOR |
1095 | CURRENT PROJECT COORDINATOR |
955 | Project Coordinator |
1096 | Project Coordinator |
956 | Marc A. Lehmann rxvt@schmorp.de |
1097 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
957 | |
1098 | |
958 | Web page maintainter |
|
|
959 | Marc A. Lehmann rxvt@schmorp.de |
|
|
960 | |
|
|
961 | <http://software.schmorp.de/> |
1099 | <http://software.schmorp.de/#rxvt-unicode> |
962 | |
1100 | |
963 | AUTHORS |
1101 | AUTHORS |
964 | John Bovey |
1102 | John Bovey |
965 | University of Kent, 1992, wrote the original Xvt. |
1103 | University of Kent, 1992, wrote the original Xvt. |
966 | |
1104 | |
… | |
… | |
980 | |
1118 | |
981 | Geoff Wing <gcw@pobox.com> |
1119 | Geoff Wing <gcw@pobox.com> |
982 | Rewrote screen display and text selection routines. Project |
1120 | Rewrote screen display and text selection routines. Project |
983 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1121 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
984 | |
1122 | |
985 | Marc Alexander Lehmann <rxvt@schmorp.de> |
1123 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
986 | Forked rxvt-unicode, rewrote most of the display code and internal |
1124 | Forked rxvt-unicode, rewrote most of the display code and internal |
987 | character handling to store text in unicode, improve xterm |
1125 | character handling to store text in unicode, improve xterm |
988 | compatibility and apply numerous other bugfixes and extensions. |
1126 | compatibility and apply numerous other bugfixes and extensions. |
989 | |
1127 | |
990 | Project Coordinator (Changes 1.0 -) |
1128 | Project Coordinator (Changes 1.0 -) |