… | |
… | |
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 5.2, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 6.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 | |
… | |
… | |
93 | Turn on/off simulated reverse video; resource reverseVideo. |
93 | Turn on/off simulated reverse video; resource reverseVideo. |
94 | |
94 | |
95 | -j|+j |
95 | -j|+j |
96 | Turn on/off jump scrolling; resource jumpScroll. |
96 | Turn on/off jump scrolling; resource jumpScroll. |
97 | |
97 | |
98 | -ip|+ip |
98 | -ip|+ip | -tr|+tr |
99 | Turn on/off inheriting parent window's pixmap. Alternative form is |
99 | Turn on/off inheriting parent window's pixmap. Alternative form is |
100 | -tr; resource inheritPixmap. |
100 | -tr; resource inheritPixmap. |
101 | |
101 | |
102 | -fade *number* |
102 | -fade *number* |
103 | Fade the text by the given percentage when focus is lost. resource |
103 | Fade the text by the given percentage when focus is lost. Small |
104 | fading. |
104 | values fade a little only, 100 completely replaces all colours by |
|
|
105 | the fade colour; resource fading. |
|
|
106 | |
|
|
107 | -fadecolor *colour* |
|
|
108 | Fade to this colour when fading is used (see -fade). The default |
|
|
109 | colour is black. resource fadeColor. |
105 | |
110 | |
106 | -tint *colour* |
111 | -tint *colour* |
107 | Tint the transparent background pixmap with the given colour when |
112 | Tint the transparent background pixmap with the given colour when |
108 | transparency is enabled with -tr or -ip. See also the -sh option |
113 | transparency is enabled with -tr or -ip. This only works for |
|
|
114 | non-tiled backgrounds, currently. See also the -sh option that can |
109 | that can be used to brighten or darken the image in addition to |
115 | be used to brighten or darken the image in addition to tinting it; |
110 | tinting it. |
116 | resource *tintColor*. Example: |
|
|
117 | |
|
|
118 | rxvt -tr -tint blue -sh 40 |
111 | |
119 | |
112 | -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
120 | -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
113 | background image in addition to tinting it (i.e. -tint must be |
121 | background image in addition to tinting it (i.e. -tint must be |
114 | specified, too, e.g. "-tint white"). |
122 | specified, too, e.g. "-tint white"). |
115 | |
123 | |
… | |
… | |
204 | |
212 | |
205 | -sr|+sr |
213 | -sr|+sr |
206 | Put scrollbar on right/left; resource scrollBar_right. |
214 | Put scrollbar on right/left; resource scrollBar_right. |
207 | |
215 | |
208 | -st|+st |
216 | -st|+st |
209 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
217 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
210 | resource scrollBar_floating. |
218 | resource scrollBar_floating. |
211 | |
219 | |
212 | -ptab|+ptab |
220 | -ptab|+ptab |
213 | If enabled (default), "Horizontal Tab" characters are being stored |
221 | If enabled (default), "Horizontal Tab" characters are being stored |
214 | as actual wide characters in the screen buffer, which makes it |
222 | as actual wide characters in the screen buffer, which makes it |
… | |
… | |
259 | on the command line. If this option is used, it must be the last on |
267 | on the command line. If this option is used, it must be the last on |
260 | the command-line. If there is no -e option then the default is to |
268 | the command-line. If there is no -e option then the default is to |
261 | run the program specified by the SHELL environment variable or, |
269 | run the program specified by the SHELL environment variable or, |
262 | failing that, *sh(1)*. |
270 | failing that, *sh(1)*. |
263 | |
271 | |
|
|
272 | Please note that you must specify a program with arguments. If you |
|
|
273 | want to run shell commands, you have to specify the shell, like |
|
|
274 | this: |
|
|
275 | |
|
|
276 | rxvt -e sh -c "shell commands" |
|
|
277 | |
264 | -title *text* |
278 | -title *text* |
265 | Window title (-T still respected); the default title is the basename |
279 | Window title (-T still respected); the default title is the basename |
266 | of the program specified after the -e option, if any, otherwise the |
280 | of the program specified after the -e option, if any, otherwise the |
267 | application name; resource title. |
281 | application name; resource title. |
268 | |
282 | |
… | |
… | |
311 | |
325 | |
312 | -ssr|+ssr |
326 | -ssr|+ssr |
313 | Turn on/off secondary screen scroll (default enabled); resource |
327 | Turn on/off secondary screen scroll (default enabled); resource |
314 | secondaryScroll. |
328 | secondaryScroll. |
315 | |
329 | |
|
|
330 | -hold|+hold |
|
|
331 | Turn on/off hold window after exit support. If enabled, rxvt will |
|
|
332 | not immediately destroy its window when the program executed within |
|
|
333 | it exits. Instead, it will wait till it is being killed or closed by |
|
|
334 | the user; resource hold. |
|
|
335 | |
316 | -keysym.*sym* *string* |
336 | -keysym.*sym* *string* |
317 | Remap a key symbol. See resource keysym. |
337 | Remap a key symbol. See resource keysym. |
318 | |
338 | |
319 | -embed *windowid* |
339 | -embed *windowid* |
320 | Tells rxvt to embed it's windows into an already-existing window, |
340 | Tells rxvt to embed it's windows into an already-existing window, |
… | |
… | |
334 | used or not. |
354 | used or not. |
335 | |
355 | |
336 | Here is a short Gtk2-perl snippet that illustrates how this option |
356 | Here is a short Gtk2-perl snippet that illustrates how this option |
337 | can be used (a longer example is in doc/embed): |
357 | can be used (a longer example is in doc/embed): |
338 | |
358 | |
339 | my $rxvt = new Gtk2::DrawingArea; |
359 | my $rxvt = new Gtk2::Socket; |
340 | $...->add ($rxvt); # important to add it somewhere first |
360 | $rxvt->signal_connect_after (realize => sub { |
341 | $rxvt->realize; # now it can be realized |
|
|
342 | my $xid = $rxvt->window->get_xid; |
361 | my $xid = $_[0]->window->get_xid; |
343 | |
|
|
344 | system "rxvt -embed $xid &"; |
362 | system "rxvt -embed $xid &"; |
|
|
363 | }); |
345 | |
364 | |
346 | -pty-fd *fileno* |
365 | -pty-fd *fileno* |
347 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
366 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
348 | but instead use the given filehandle as the tty master. This is |
367 | but instead use the given filehandle as the tty master. This is |
349 | useful if you want to drive rxvt as a generic terminal emulator |
368 | useful if you want to drive rxvt as a generic terminal emulator |
… | |
… | |
359 | use IO::Pty; |
378 | use IO::Pty; |
360 | use Fcntl; |
379 | use Fcntl; |
361 | |
380 | |
362 | my $pty = new IO::Pty; |
381 | my $pty = new IO::Pty; |
363 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
382 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
364 | |
|
|
365 | system "rxvt -pty-fd " . (fileno $pty) . "&"; |
383 | system "rxvt -pty-fd " . (fileno $pty) . "&"; |
|
|
384 | close $pty; |
366 | |
385 | |
367 | # now communicate with rxvt |
386 | # now communicate with rxvt |
368 | my $slave = $pty->slave; |
387 | my $slave = $pty->slave; |
369 | while (<$slave>) { print $slave "got <$_>\n" } |
388 | while (<$slave>) { print $slave "got <$_>\n" } |
370 | |
389 | |
… | |
… | |
468 | True: make the background inherit the parent windows' pixmap, giving |
487 | True: make the background inherit the parent windows' pixmap, giving |
469 | artificial transparency. False: do not inherit the parent windows' |
488 | artificial transparency. False: do not inherit the parent windows' |
470 | pixmap. |
489 | pixmap. |
471 | |
490 | |
472 | fading: *number* |
491 | fading: *number* |
473 | Fade the text by the given percentage when focus is lost. |
492 | Fade the text by the given percentage when focus is lost; option |
|
|
493 | -fade. |
|
|
494 | |
|
|
495 | fadeColor: *colour* |
|
|
496 | Fade to this colour, when fading is used (see fading:). The default |
|
|
497 | colour is black; option -fadecolor. |
474 | |
498 | |
475 | tintColor: *colour* |
499 | tintColor: *colour* |
476 | Tint the transparent background pixmap with the given colour. |
500 | Tint the transparent background pixmap with the given colour; option |
|
|
501 | -tint. |
477 | |
502 | |
478 | shading: *number* |
503 | shading: *number* |
479 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
504 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
480 | image in addition to tinting it. |
505 | image in addition to tinting it. |
481 | |
506 | |
482 | scrollColor: *colour* |
507 | scrollColor: *colour* |
483 | Use the specified colour for the scrollbar [default #B2B2B2]. |
508 | Use the specified colour for the scrollbar [default #B2B2B2]. |
484 | |
509 | |
485 | troughColor: *colour* |
510 | troughColor: *colour* |
486 | Use the specified colour for the scrollbar's trough area [default |
511 | Use the specified colour for the scrollbar's trough area [default |
487 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
512 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
488 | |
513 | |
489 | borderColor: *colour* |
514 | borderColor: *colour* |
490 | The colour of the border around the text area and between the |
515 | The colour of the border around the text area and between the |
491 | scrollbar and the text. |
516 | scrollbar and the text. |
492 | |
517 | |
… | |
… | |
578 | xterm style with 2.20 old word selection, or anything else which |
603 | xterm style with 2.20 old word selection, or anything else which |
579 | gives xterm style selection. |
604 | gives xterm style selection. |
580 | |
605 | |
581 | scrollstyle: *mode* |
606 | scrollstyle: *mode* |
582 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
607 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
583 | author's favourite.. |
608 | author's favourite. |
584 | |
609 | |
585 | title: *string* |
610 | title: *string* |
586 | Set window title string, the default title is the command-line |
611 | Set window title string, the default title is the command-line |
587 | specified after the -e option, if any, otherwise the application |
612 | specified after the -e option, if any, otherwise the application |
588 | name; option -title. |
613 | name; option -title. |
… | |
… | |
612 | |
637 | |
613 | print-pipe: *string* |
638 | print-pipe: *string* |
614 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
639 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
615 | Print to initiate a screen dump to the printer and Ctrl-Print or |
640 | Print to initiate a screen dump to the printer and Ctrl-Print or |
616 | Shift-Print to include the scrollback as well. |
641 | Shift-Print to include the scrollback as well. |
|
|
642 | |
|
|
643 | The string will be interpreted as if typed into the shell as-is. |
|
|
644 | |
|
|
645 | Example: |
|
|
646 | |
|
|
647 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
648 | |
|
|
649 | This creates a new file in your home directory with the screen |
|
|
650 | contents everytime you hit "Print". |
617 | |
651 | |
618 | scrollBar: *boolean* |
652 | scrollBar: *boolean* |
619 | True: enable the scrollbar [default]; option -sb. False: disable the |
653 | True: enable the scrollbar [default]; option -sb. False: disable the |
620 | scrollbar; option +sb. |
654 | scrollbar; option +sb. |
621 | |
655 | |
… | |
… | |
698 | pointerColor2: *colour* |
732 | pointerColor2: *colour* |
699 | Mouse pointer background colour. |
733 | Mouse pointer background colour. |
700 | |
734 | |
701 | pointerBlankDelay: *number* |
735 | pointerBlankDelay: *number* |
702 | Specifies number of seconds before blanking the pointer [default 2]. |
736 | Specifies number of seconds before blanking the pointer [default 2]. |
|
|
737 | Use a large number (e.g. 987654321) to effectively disable the |
|
|
738 | timeout. |
703 | |
739 | |
704 | backspacekey: *string* |
740 | backspacekey: *string* |
705 | The string to send when the backspace key is pressed. If set to DEC |
741 | The string to send when the backspace key is pressed. If set to DEC |
706 | or unset it will send Delete (code 127) or, if shifted, Backspace |
742 | or unset it will send Delete (code 127) or, if shifted, Backspace |
707 | (code 8) - which can be reversed with the appropriate DEC private |
743 | (code 8) - which can be reversed with the appropriate DEC private |
… | |
… | |
745 | |
781 | |
746 | insecure: *boolean* |
782 | insecure: *boolean* |
747 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
783 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
748 | that echo arbitrary strings like the icon name or the locale. This |
784 | that echo arbitrary strings like the icon name or the locale. This |
749 | could be abused if somebody gets 8-bit-clean access to your display, |
785 | could be abused if somebody gets 8-bit-clean access to your display, |
750 | whether throuh a mail client displaying mail bodies unfiltered or |
786 | whether through a mail client displaying mail bodies unfiltered or |
751 | though write(1). Therefore, these sequences are disabled by default. |
787 | through write(1) or any other means. Therefore, these sequences are |
752 | (Note that other terminals, including xterm, have these sequences |
788 | disabled by default. (Note that many other terminals, including |
753 | enabled by default). You can enable them by setting this boolean |
789 | xterm, have these sequences enabled by default, which doesn't make |
754 | resource or specifying -insecure as an option. At the moment, this |
790 | it safer, though). |
755 | enabled display-answer, locale, findfont, icon label and window |
791 | |
756 | title requests as well as dynamic menubar dispatch. |
792 | You can enable them by setting this boolean resource or specifying |
|
|
793 | -insecure as an option. At the moment, this enables display-answer, |
|
|
794 | locale, findfont, icon label and window title requests as well as |
|
|
795 | dynamic menubar dispatch. |
757 | |
796 | |
758 | modifier: *modifier* |
797 | modifier: *modifier* |
759 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
798 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
760 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
799 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
761 | |
800 | |
… | |
… | |
770 | secondaryScroll: *bool* |
809 | secondaryScroll: *bool* |
771 | Turn on/off secondary screen scroll (default enabled). If the this |
810 | Turn on/off secondary screen scroll (default enabled). If the this |
772 | option is enabled, scrolls on the secondary screen will change the |
811 | option is enabled, scrolls on the secondary screen will change the |
773 | scrollback buffer and switching to/from the secondary screen will |
812 | scrollback buffer and switching to/from the secondary screen will |
774 | instead scroll the screen up. |
813 | instead scroll the screen up. |
|
|
814 | |
|
|
815 | hold: *bool* |
|
|
816 | Turn on/off hold window after exit support. If enabled, rxvt will |
|
|
817 | not immediately destroy its window when the program executed within |
|
|
818 | it exits. Instead, it will wait till it is being killed or closed by |
|
|
819 | the user. |
775 | |
820 | |
776 | keysym.*sym*: *string* |
821 | keysym.*sym*: *string* |
777 | Compile *frills*: Associate *string* with keysym *sym*. The |
822 | Compile *frills*: Associate *string* with keysym *sym*. The |
778 | intervening resource name keysym. cannot be omitted. |
823 | intervening resource name keysym. cannot be omitted. |
779 | |
824 | |
… | |
… | |
824 | the following means "change the current locale to "zh_CN.GBK" when |
869 | the following means "change the current locale to "zh_CN.GBK" when |
825 | Control-Meta-c is being pressed": |
870 | Control-Meta-c is being pressed": |
826 | |
871 | |
827 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
872 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
828 | |
873 | |
|
|
874 | Due the the large number of modifier combinations, a defined key |
|
|
875 | mapping will match if at *at least* the specified identifiers are |
|
|
876 | being set, and no other key mappings with those and more bits are |
|
|
877 | being defined. That means that defining a key map for "a" will |
|
|
878 | automatically provide definitions for "Meta-a", "Shift-a" and so on, |
|
|
879 | unless some of those are defined mappings themselves. |
|
|
880 | |
|
|
881 | Unfortunately, this will override built-in key mappings. For example |
|
|
882 | if you overwrite the "Insert" key you will disable rxvt's |
|
|
883 | "Shift-Insert" mapping. To re-enable that, you can poke "holes" into |
|
|
884 | the user-defined keymap using the "builtin:" replacement: |
|
|
885 | |
|
|
886 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
887 | URxvt.keysym.S-Insert: builtin: |
|
|
888 | |
|
|
889 | The first line defines a mapping for "Insert" and *any* combination |
|
|
890 | of modifiers. The second line re-establishes the default mapping for |
|
|
891 | "Shift-Insert". |
|
|
892 | |
829 | The following example will map Control-Meta-1 and Control-Meta-2 to |
893 | The following example will map Control-Meta-1 and Control-Meta-2 to |
830 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
894 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
831 | font-switching at runtime: |
895 | font-switching at runtime: |
832 | |
896 | |
833 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
897 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
… | |
… | |
886 | supported in rxvt-unicode. Bug me if you need this. |
950 | supported in rxvt-unicode. Bug me if you need this. |
887 | |
951 | |
888 | You can, however, switch fonts at runtime using escape sequences (and |
952 | You can, however, switch fonts at runtime using escape sequences (and |
889 | therefore using the menubar), e.g.: |
953 | therefore using the menubar), e.g.: |
890 | |
954 | |
891 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
955 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
892 | |
956 | |
893 | rxvt-unicode will automatically re-apply these fonts to the output so |
957 | rxvt-unicode will automatically re-apply these fonts to the output so |
894 | far. |
958 | far. |
895 | |
959 | |
896 | ISO 14755 SUPPORT |
960 | ISO 14755 SUPPORT |
… | |
… | |
1042 | Used in the same way as "RXVTPATH". |
1106 | Used in the same way as "RXVTPATH". |
1043 | |
1107 | |
1044 | RXVT_SOCKET |
1108 | RXVT_SOCKET |
1045 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1109 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1046 | |
1110 | |
1047 | Default "$HOME/.rxvt-unicode-<nodename". |
1111 | Default $HOME/.rxvt-unicode-*<nodename*. |
1048 | |
1112 | |
1049 | HOME |
1113 | HOME |
1050 | Used to locate the default directory for the unix domain socket for |
1114 | Used to locate the default directory for the unix domain socket for |
1051 | daemon communications and to locate various resource files (such as |
1115 | daemon communications and to locate various resource files (such as |
1052 | ".Xdefaults") |
1116 | ".Xdefaults") |
… | |
… | |
1061 | FILES |
1125 | FILES |
1062 | /usr/lib/X11/rgb.txt |
1126 | /usr/lib/X11/rgb.txt |
1063 | Color names. |
1127 | Color names. |
1064 | |
1128 | |
1065 | SEE ALSO |
1129 | SEE ALSO |
1066 | rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1130 | rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), |
1067 | |
1131 | tty(4), utmp(5) |
1068 | BUGS |
|
|
1069 | Check the BUGS file for an up-to-date list. |
|
|
1070 | |
|
|
1071 | Cursor change support is not yet implemented. |
|
|
1072 | |
|
|
1073 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1074 | |
1132 | |
1075 | CURRENT PROJECT COORDINATOR |
1133 | CURRENT PROJECT COORDINATOR |
1076 | Project Coordinator |
1134 | Project Coordinator |
1077 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1135 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1078 | |
1136 | |