… | |
… | |
6 | |
6 | |
7 | B<@@RXVT_NAME@@> [options] [-e command [ args ]] |
7 | B<@@RXVT_NAME@@> [options] [-e command [ args ]] |
8 | |
8 | |
9 | =head1 DESCRIPTION |
9 | =head1 DESCRIPTION |
10 | |
10 | |
11 | B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal |
11 | B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 | a significant advantage on a machine serving many X sessions. |
15 | a significant advantage on a machine serving many X sessions. |
16 | |
16 | |
17 | See also @@RXVT_NAME@@(7) for technical reference documentation (escape |
17 | See also @@RXVT_NAME@@(7) for technical reference documentation (escape |
18 | sequences etc.). |
18 | sequences etc.) and the FAQ section at the end of this document. |
19 | |
19 | |
20 | =head1 OPTIONS |
20 | =head1 OPTIONS |
21 | |
21 | |
22 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
22 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
23 | below. In keeping with the smaller-is-better philosophy, options may be |
23 | below. In keeping with the smaller-is-better philosophy, options may be |
24 | eliminated or default values chosen at compile-time, so options and |
24 | eliminated or default values chosen at compile-time, so options and |
25 | defaults listed may not accurately reflect the version installed on |
25 | defaults listed may not accurately reflect the version installed on |
26 | your system. `rxvt -h' gives a list of major compile-time options on |
26 | your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on |
27 | the I<Options> line. Option descriptions may be prefixed with which |
27 | the I<Options> line. Option descriptions may be prefixed with which |
28 | compile option each is dependent upon. e.g. `Compile I<XIM>:' requires |
28 | compile option each is dependent upon. e.g. `Compile I<XIM>:' requires |
29 | I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all |
29 | I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all |
30 | command-line options compiled into your version. |
30 | command-line options compiled into your version. |
31 | |
31 | |
32 | Note that B<@@RXVT_NAME@@> permits the resource name to be used as a |
32 | Note that B<@@RXVT_NAME@@> permits the resource name to be used as a |
33 | long-option (--/++ option) so the potential command-line options are |
33 | long-option (--/++ option) so the potential command-line options are |
34 | far greater than those listed. For example: `rxvt --loginShell --color1 |
34 | far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
35 | Orange'. |
35 | Orange'. |
36 | |
36 | |
37 | The following options are available: |
37 | The following options are available: |
38 | |
38 | |
39 | =over 4 |
39 | =over 4 |
… | |
… | |
205 | B<externalBorder>. |
205 | B<externalBorder>. |
206 | |
206 | |
207 | =item B<-bl> |
207 | =item B<-bl> |
208 | |
208 | |
209 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
209 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
210 | if honoured by the WM, the rxvt window will not have window |
210 | if honoured by the WM, the rxvt-unicode window will not have window |
211 | decorations; resource B<borderLess>. |
211 | decorations; resource B<borderLess>. |
212 | |
212 | |
213 | =item B<-lsp> I<number> |
213 | =item B<-lsp> I<number> |
214 | |
214 | |
215 | Compile I<linespace>: Lines (pixel height) to insert between each row |
215 | Compile I<linespace>: Lines (pixel height) to insert between each row |
… | |
… | |
286 | Turn on/off secondary screen scroll (default enabled); resource |
286 | Turn on/off secondary screen scroll (default enabled); resource |
287 | B<secondaryScroll>. |
287 | B<secondaryScroll>. |
288 | |
288 | |
289 | =item B<-xrm> I<resourcestring> |
289 | =item B<-xrm> I<resourcestring> |
290 | |
290 | |
291 | No effect on rxvt. Simply passes through an argument to be made |
291 | No effect on rxvt-unicode. Simply passes through an argument to be made |
292 | available in the instance's argument list. Appears in I<WM_COMMAND> in |
292 | available in the instance's argument list. Appears in I<WM_COMMAND> in |
293 | some window managers. |
293 | some window managers. |
294 | |
294 | |
295 | =back |
295 | =back |
296 | |
296 | |
… | |
… | |
465 | xterm style with 2.20 old word selection, or anything else which gives |
465 | xterm style with 2.20 old word selection, or anything else which gives |
466 | xterm style selection. |
466 | xterm style selection. |
467 | |
467 | |
468 | =item B<scrollstyle:> I<mode> |
468 | =item B<scrollstyle:> I<mode> |
469 | |
469 | |
470 | Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or |
470 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
471 | B<xterm> |
471 | the author's favourite.. |
472 | |
472 | |
473 | =item B<title:> I<string> |
473 | =item B<title:> I<string> |
474 | |
474 | |
475 | Set window title string, the default title is the command-line |
475 | Set window title string, the default title is the command-line |
476 | specified after the B<-e> option, if any, otherwise the application |
476 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
542 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
542 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
543 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
543 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
544 | |
544 | |
545 | =item B<scrollTtyKeypress:> I<boolean> |
545 | =item B<scrollTtyKeypress:> I<boolean> |
546 | |
546 | |
547 | B<True>: scroll to bottom when a non-special key is pressed. Special |
547 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
548 | keys are those which are intercepted by rxvt for special handling and |
548 | are those which are intercepted by rxvt-unicode for special handling and |
549 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll |
549 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
550 | to bottom when a non-special key is pressed; option B<+sk>. |
550 | bottom when a non-special key is pressed; option B<+sk>. |
551 | |
551 | |
552 | =item B<smallfont_key:> I<keysym> |
552 | =item B<smallfont_key:> I<keysym> |
553 | |
553 | |
554 | If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font |
554 | If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font |
555 | [default B<@@HOTKEY@@-@@SMALLFONT@@>] |
555 | [default B<@@HOTKEY@@-@@SMALLFONT@@>] |
… | |
… | |
575 | option B<-w>, B<-bw>, B<-borderwidth>. |
575 | option B<-w>, B<-bw>, B<-borderwidth>. |
576 | |
576 | |
577 | =item B<borderLess:> I<boolean> |
577 | =item B<borderLess:> I<boolean> |
578 | |
578 | |
579 | Set MWM hints to request a borderless window, i.e. if honoured by the |
579 | Set MWM hints to request a borderless window, i.e. if honoured by the |
580 | WM, the rxvt window will not have window decorations; option B<-bl>. |
580 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
581 | |
581 | |
582 | =item B<termName:> I<termname> |
582 | =item B<termName:> I<termname> |
583 | |
583 | |
584 | Specifies the terminal type name to be set in the B<TERM> environment |
584 | Specifies the terminal type name to be set in the B<TERM> environment |
585 | variable; option B<-tn>. |
585 | variable; option B<-tn>. |
… | |
… | |
676 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
676 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
677 | B<-mod>. |
677 | B<-mod>. |
678 | |
678 | |
679 | =item B<answerbackString:> I<string> |
679 | =item B<answerbackString:> I<string> |
680 | |
680 | |
681 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
681 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
682 | character is passed through. It may contain escape values as described |
682 | character is passed through. It may contain escape values as described |
683 | in the entry on B<keysym> following. |
683 | in the entry on B<keysym> following. |
684 | |
684 | |
685 | =item B<secondaryScreen:> I<bool> |
685 | =item B<secondaryScreen:> I<bool> |
686 | |
686 | |
… | |
… | |
823 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
823 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
824 | been specified. For example, |
824 | been specified. For example, |
825 | |
825 | |
826 | =over 4 |
826 | =over 4 |
827 | |
827 | |
828 | =item B<rxvt -fg Black -bg White -rv> |
828 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
829 | |
829 | |
830 | would yield White on Black, while on I<xterm>(1) it would yield Black |
830 | would yield White on Black, while on I<xterm>(1) it would yield Black |
831 | on White. |
831 | on White. |
832 | |
832 | |
833 | =back |
833 | =back |
… | |
… | |
853 | |
853 | |
854 | Color names. |
854 | Color names. |
855 | |
855 | |
856 | =back |
856 | =back |
857 | |
857 | |
|
|
858 | =head1 FREQUENTLY ASKED QUESTIONS (FAQ) |
|
|
859 | |
|
|
860 | =over 4 |
|
|
861 | |
|
|
862 | =item How do I know which rxvt-unicode version I'm using? |
|
|
863 | |
|
|
864 | The version number is displayed with the usage (-h). For rxvt-unicode |
|
|
865 | version 2.14 and later, the escape sequence C<ESC[8n> sets the window |
|
|
866 | title to the version number. |
|
|
867 | |
|
|
868 | =item Mouse cut/paste suddenly no longer works. |
|
|
869 | |
|
|
870 | Make sure that mouse reporting is actually turned off since killing |
|
|
871 | some editors prematurely may leave the mouse in mouse report mode. I've |
|
|
872 | heard that tcsh may use mouse reporting unless it otherwise specified. A |
|
|
873 | quick check is to see if cut/paste works when the Alt or Shift keys are |
|
|
874 | depressed. See @@RXVT_NAME@@(7) |
|
|
875 | |
|
|
876 | =item What's with this bold/blink stuff? |
|
|
877 | |
|
|
878 | If no bold colour is set via C<colorBD:>, bold will invert text using the |
|
|
879 | standard foreground colour. |
|
|
880 | |
|
|
881 | For the standard background colour, blinking will actually make the |
|
|
882 | text blink when compiled with C<--enable-blinking>. with standard |
|
|
883 | colours. Without C<--enable-blinking>, the blink attribute will be |
|
|
884 | ignored. |
|
|
885 | |
|
|
886 | On ANSI colours, bold/blink attributes are used to set high-intensity |
|
|
887 | foreground/background colors. |
|
|
888 | |
|
|
889 | color0-7 are the low-intensity colors. |
|
|
890 | |
|
|
891 | color8-15 are the corresponding high-intensity colors. |
|
|
892 | |
|
|
893 | =item I don't like the screen colors. How do I change them? |
|
|
894 | |
|
|
895 | You can change the screen colors at run-time using F<~/.Xdefaults> |
|
|
896 | resources (or as long-options). |
|
|
897 | |
|
|
898 | Here are values that are supposed to resemble a VGA screen, |
|
|
899 | including the murky brown that passes for low-intensity yellow: |
|
|
900 | |
|
|
901 | Rxvt*color0: #000000 |
|
|
902 | Rxvt*color1: #A80000 |
|
|
903 | Rxvt*color2: #00A800 |
|
|
904 | Rxvt*color3: #A8A800 |
|
|
905 | Rxvt*color4: #0000A8 |
|
|
906 | Rxvt*color5: #A800A8 |
|
|
907 | Rxvt*color6: #00A8A8 |
|
|
908 | Rxvt*color7: #A8A8A8 |
|
|
909 | |
|
|
910 | Rxvt*color8: #000054 |
|
|
911 | Rxvt*color9: #FF0054 |
|
|
912 | Rxvt*color10: #00FF54 |
|
|
913 | Rxvt*color11: #FFFF54 |
|
|
914 | Rxvt*color12: #0000FF |
|
|
915 | Rxvt*color13: #FF00FF |
|
|
916 | Rxvt*color14: #00FFFF |
|
|
917 | Rxvt*color15: #FFFFFF |
|
|
918 | |
|
|
919 | =item What's with the strange Backspace/Delete key behaviour? |
|
|
920 | |
|
|
921 | Assuming that the physical Backspace key corresponds to the |
|
|
922 | BackSpace keysym (not likely for Linux ... see the following |
|
|
923 | question) there are two standard values that can be used for |
|
|
924 | Backspace: C<^H> and C<^?>. |
|
|
925 | |
|
|
926 | Historically, either value is correct, but rxvt-unicode adopts the debian |
|
|
927 | policy of using C<^?> when unsure, because it's the one only only correct |
|
|
928 | choice :). |
|
|
929 | |
|
|
930 | Rxvt-unicode tries to inherit the current stty settings and uses the value |
|
|
931 | of `erase' to guess the value for backspace. If rxvt-unicode wasn't |
|
|
932 | started from a terminal (say, from a menu or by remote shell), then the |
|
|
933 | system value of `erase', which corresponds to CERASE in <termios.h>, will |
|
|
934 | be used (which may not be the same as your stty setting). |
|
|
935 | |
|
|
936 | For starting a new rxvt-unicode: |
|
|
937 | |
|
|
938 | # use Backspace = ^H |
|
|
939 | $ stty erase ^H |
|
|
940 | $ @@RXVT_NAME@@ |
|
|
941 | |
|
|
942 | # use Backspace = ^? |
|
|
943 | $ stty erase ^? |
|
|
944 | $ @@RXVT_NAME@@ |
|
|
945 | |
|
|
946 | Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). |
|
|
947 | |
|
|
948 | For an existing rxvt-unicode: |
|
|
949 | |
|
|
950 | # use Backspace = ^H |
|
|
951 | $ stty erase ^H |
|
|
952 | $ echo -n "^[[36h" |
|
|
953 | |
|
|
954 | # use Backspace = ^? |
|
|
955 | $ stty erase ^? |
|
|
956 | $ echo -n "^[[36l" |
|
|
957 | |
|
|
958 | This helps satisfy some of the Backspace discrepancies that occur, but |
|
|
959 | if you use Backspace = C<^H>, make sure that the termcap/terminfo value |
|
|
960 | properly reflects that. |
|
|
961 | |
|
|
962 | The Delete key is a another casualty of the ill-defined Backspace problem. |
|
|
963 | To avoid confusion between the Backspace and Delete keys, the Delete |
|
|
964 | key has been assigned an escape sequence to match the vt100 for Execute |
|
|
965 | (ESC[3~) and is in the supplied termcap/terminfo. |
|
|
966 | |
|
|
967 | Some other Backspace problems: |
|
|
968 | |
|
|
969 | some editors use termcap/terminfo, |
|
|
970 | some editors (vim I'm told) expect Backspace = ^H, |
|
|
971 | GNU Emacs (and Emacs-like editors) use ^H for help. |
|
|
972 | |
|
|
973 | Perhaps someday this will all be resolved in a consistent manner. |
|
|
974 | |
|
|
975 | =item I don't like the key-bindings. How do I change them? |
|
|
976 | |
|
|
977 | There are some compile-time selections available via configure. Unless |
|
|
978 | you have run "configure" with the C<--disable-resources> option you can |
|
|
979 | use the `keysym' resource to alter the keystrings associated with keysym |
|
|
980 | 0xFF00 - 0xFFFF (function, cursor keys, etc). |
|
|
981 | |
|
|
982 | Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270' |
|
|
983 | |
|
|
984 | !# ----- special uses ------: |
|
|
985 | ! tn3270 login, remap function and arrow keys. |
|
|
986 | tn3270*font: *clean-bold-*-*--15-* |
|
|
987 | |
|
|
988 | ! keysym - used by rxvt only |
|
|
989 | ! Delete - ^D |
|
|
990 | tn3270*keysym.0xFFFF: \004 |
|
|
991 | |
|
|
992 | ! Home - ^A |
|
|
993 | tn3270*keysym.0xFF50: \001 |
|
|
994 | ! Left - ^B |
|
|
995 | tn3270*keysym.0xFF51: \002 |
|
|
996 | ! Up - ^P |
|
|
997 | tn3270*keysym.0xFF52: \020 |
|
|
998 | ! Right - ^F |
|
|
999 | tn3270*keysym.0xFF53: \006 |
|
|
1000 | ! Down - ^N |
|
|
1001 | tn3270*keysym.0xFF54: \016 |
|
|
1002 | ! End - ^E |
|
|
1003 | tn3270*keysym.0xFF57: \005 |
|
|
1004 | |
|
|
1005 | ! F1 - F12 |
|
|
1006 | tn3270*keysym.0xFFBE: \e1 |
|
|
1007 | tn3270*keysym.0xFFBF: \e2 |
|
|
1008 | tn3270*keysym.0xFFC0: \e3 |
|
|
1009 | tn3270*keysym.0xFFC1: \e4 |
|
|
1010 | tn3270*keysym.0xFFC2: \e5 |
|
|
1011 | tn3270*keysym.0xFFC3: \e6 |
|
|
1012 | tn3270*keysym.0xFFC4: \e7 |
|
|
1013 | tn3270*keysym.0xFFC5: \e8 |
|
|
1014 | tn3270*keysym.0xFFC6: \e9 |
|
|
1015 | tn3270*keysym.0xFFC7: \e0 |
|
|
1016 | tn3270*keysym.0xFFC8: \e- |
|
|
1017 | tn3270*keysym.0xFFC9: \e= |
|
|
1018 | |
|
|
1019 | ! map Prior/Next to F7/F8 |
|
|
1020 | tn3270*keysym.0xFF55: \e7 |
|
|
1021 | tn3270*keysym.0xFF56: \e8 |
|
|
1022 | |
|
|
1023 | =item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. |
|
|
1024 | How do I make use of them? For example, the Sun Keyboard type 4 |
|
|
1025 | has the following mappings that rxvt-unicode doesn't recognize. |
|
|
1026 | |
|
|
1027 | KP_Insert == Insert |
|
|
1028 | F22 == Print |
|
|
1029 | F27 == Home |
|
|
1030 | F29 == Prior |
|
|
1031 | F33 == End |
|
|
1032 | F35 == Next |
|
|
1033 | |
|
|
1034 | Rather than have rxvt-unicode try to accomodate all the various possible keyboard |
|
|
1035 | mappings, it is better to use `xmodmap' to remap the keys as required for |
|
|
1036 | your particular machine. |
|
|
1037 | |
|
|
1038 | =item How do I distinguish if I'm running rxvt-unicode or a regular xterm? |
|
|
1039 | I need this to decide about setting colors etc. |
|
|
1040 | |
|
|
1041 | rxvt and rxvt-unicode always export the variable "COLORTERM", so you can |
|
|
1042 | check and see if that is set. Note that several programs, JED, slrn, |
|
|
1043 | Midnight Commander automatically check this variable to decide whether or |
|
|
1044 | not to use color. |
|
|
1045 | |
|
|
1046 | =item How do I set the correct, full IP address for the DISPLAY variable? |
|
|
1047 | |
|
|
1048 | If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled |
|
|
1049 | insecure mode then it is possible to use the following shell script |
|
|
1050 | snippets to correctly set the display. If your version of rxvt-unicode |
|
|
1051 | wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then |
|
|
1052 | the COLORTERM variable can be used to distinguish rxvt-unicode from a |
|
|
1053 | regular xterm. |
|
|
1054 | |
|
|
1055 | Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script |
|
|
1056 | snippets: |
|
|
1057 | |
|
|
1058 | # Bourne/Korn/POSIX family of shells: |
|
|
1059 | [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know |
|
|
1060 | if [ ${TERM:-foo} = xterm ]; then |
|
|
1061 | stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not |
|
|
1062 | echo -n '^[Z' |
|
|
1063 | read term_id |
|
|
1064 | stty icanon echo |
|
|
1065 | if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then |
|
|
1066 | echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string |
|
|
1067 | read DISPLAY # set it in our local shell |
|
|
1068 | fi |
|
|
1069 | fi |
|
|
1070 | |
|
|
1071 | =item How do I compile the manual pages for myself? |
|
|
1072 | |
|
|
1073 | You need to have a recent version of perl installed as F</usr/bin/perl>, |
|
|
1074 | one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to |
|
|
1075 | the doc subdirectory and enter C<make alldoc>. |
|
|
1076 | |
|
|
1077 | =back |
|
|
1078 | |
858 | =head1 SEEALSO |
1079 | =head1 SEE ALSO |
859 | |
1080 | |
860 | I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) |
1081 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
861 | |
|
|
862 | See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc. |
|
|
863 | |
1082 | |
864 | =head1 BUGS |
1083 | =head1 BUGS |
865 | |
1084 | |
866 | Check the BUGS file for an up-to-date list. |
1085 | Check the BUGS file for an up-to-date list. |
867 | |
1086 | |