… | |
… | |
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.1, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 5.8, 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 |
… | |
… | |
311 | |
319 | |
312 | -ssr|+ssr |
320 | -ssr|+ssr |
313 | Turn on/off secondary screen scroll (default enabled); resource |
321 | Turn on/off secondary screen scroll (default enabled); resource |
314 | secondaryScroll. |
322 | secondaryScroll. |
315 | |
323 | |
316 | -keysym.*sym*: *string* |
324 | -keysym.*sym* *string* |
317 | Remap a key symbol. See resource keysym. |
325 | Remap a key symbol. See resource keysym. |
318 | |
326 | |
319 | -embed: *windowid* |
327 | -embed *windowid* |
320 | Tells rxvt to embed it's windows into an already-existing window, |
328 | Tells rxvt to embed it's windows into an already-existing window, |
321 | which enables applications to easily embed a terminal. |
329 | which enables applications to easily embed a terminal. |
322 | |
330 | |
323 | Right now, rxvt will first unmap/map the specified window, so it |
331 | 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 |
332 | 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 |
333 | 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. |
334 | create an extra subwindow for rxvt and leave it alone. |
|
|
335 | |
|
|
336 | The window will not be destroyed when rxvt exits. |
327 | |
337 | |
328 | It might be useful to know that rxvt will not close file descriptors |
338 | It might be useful to know that rxvt will not close file descriptors |
329 | passed to it (except for stdin/out/err, of course), so you can use |
339 | passed to it (except for stdin/out/err, of course), so you can use |
330 | file descriptors to communicate with the programs within the |
340 | file descriptors to communicate with the programs within the |
331 | terminal. This works regardless of wether the "-embed" option was |
341 | terminal. This works regardless of wether the "-embed" option was |
332 | used or not. |
342 | used or not. |
|
|
343 | |
|
|
344 | Here is a short Gtk2-perl snippet that illustrates how this option |
|
|
345 | can be used (a longer example is in doc/embed): |
|
|
346 | |
|
|
347 | my $rxvt = new Gtk2::Socket; |
|
|
348 | $rxvt->signal_connect_after (realize => sub { |
|
|
349 | my $xid = $_[0]->window->get_xid; |
|
|
350 | system "rxvt -embed $xid &"; |
|
|
351 | }); |
|
|
352 | |
|
|
353 | -pty-fd *fileno* |
|
|
354 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
|
|
355 | but instead use the given filehandle as the tty master. This is |
|
|
356 | useful if you want to drive rxvt as a generic terminal emulator |
|
|
357 | without having to run a program within it. |
|
|
358 | |
|
|
359 | If this switch is given, rxvt will not create any utmp/wtmp entries |
|
|
360 | and will not tinker with pty/tty permissions - you have to do that |
|
|
361 | yourself if you want that. |
|
|
362 | |
|
|
363 | Here is a example in perl that illustrates how this option can be |
|
|
364 | used (a longer example is in doc/pty-fd): |
|
|
365 | |
|
|
366 | use IO::Pty; |
|
|
367 | use Fcntl; |
|
|
368 | |
|
|
369 | my $pty = new IO::Pty; |
|
|
370 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
371 | system "rxvt -pty-fd " . (fileno $pty) . "&"; |
|
|
372 | close $pty; |
|
|
373 | |
|
|
374 | # now communicate with rxvt |
|
|
375 | my $slave = $pty->slave; |
|
|
376 | while (<$slave>) { print $slave "got <$_>\n" } |
333 | |
377 | |
334 | RESOURCES (available also as long-options) |
378 | RESOURCES (available also as long-options) |
335 | Note: `rxvt --help' gives a list of all resources (long options) |
379 | Note: `rxvt --help' gives a list of all resources (long options) |
336 | compiled into your version. |
380 | compiled into your version. |
337 | |
381 | |
… | |
… | |
431 | True: make the background inherit the parent windows' pixmap, giving |
475 | True: make the background inherit the parent windows' pixmap, giving |
432 | artificial transparency. False: do not inherit the parent windows' |
476 | artificial transparency. False: do not inherit the parent windows' |
433 | pixmap. |
477 | pixmap. |
434 | |
478 | |
435 | fading: *number* |
479 | fading: *number* |
436 | Fade the text by the given percentage when focus is lost. |
480 | Fade the text by the given percentage when focus is lost; option |
|
|
481 | -fade. |
|
|
482 | |
|
|
483 | fadeColor: *colour* |
|
|
484 | Fade to this colour, when fading is used (see fading:). The default |
|
|
485 | colour is black; option -fadecolor. |
437 | |
486 | |
438 | tintColor: *colour* |
487 | tintColor: *colour* |
439 | Tint the transparent background pixmap with the given colour. |
488 | Tint the transparent background pixmap with the given colour; option |
|
|
489 | -tint. |
440 | |
490 | |
441 | shading: *number* |
491 | shading: *number* |
442 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
492 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
443 | image in addition to tinting it. |
493 | image in addition to tinting it. |
444 | |
494 | |
445 | scrollColor: *colour* |
495 | scrollColor: *colour* |
446 | Use the specified colour for the scrollbar [default #B2B2B2]. |
496 | Use the specified colour for the scrollbar [default #B2B2B2]. |
447 | |
497 | |
448 | troughColor: *colour* |
498 | troughColor: *colour* |
449 | Use the specified colour for the scrollbar's trough area [default |
499 | Use the specified colour for the scrollbar's trough area [default |
450 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
500 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
451 | |
501 | |
452 | borderColor: *colour* |
502 | borderColor: *colour* |
453 | The colour of the border around the text area and between the |
503 | The colour of the border around the text area and between the |
454 | scrollbar and the text. |
504 | scrollbar and the text. |
455 | |
505 | |
… | |
… | |
541 | xterm style with 2.20 old word selection, or anything else which |
591 | xterm style with 2.20 old word selection, or anything else which |
542 | gives xterm style selection. |
592 | gives xterm style selection. |
543 | |
593 | |
544 | scrollstyle: *mode* |
594 | scrollstyle: *mode* |
545 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
595 | Set scrollbar style to rxvt, plain, next or xterm. plain is the |
546 | author's favourite.. |
596 | author's favourite. |
547 | |
597 | |
548 | title: *string* |
598 | title: *string* |
549 | Set window title string, the default title is the command-line |
599 | Set window title string, the default title is the command-line |
550 | specified after the -e option, if any, otherwise the application |
600 | specified after the -e option, if any, otherwise the application |
551 | name; option -title. |
601 | name; option -title. |
… | |
… | |
576 | print-pipe: *string* |
626 | print-pipe: *string* |
577 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
627 | Specify a command pipe for vt100 printer [default *lpr(1)*]. Use |
578 | Print to initiate a screen dump to the printer and Ctrl-Print or |
628 | Print to initiate a screen dump to the printer and Ctrl-Print or |
579 | Shift-Print to include the scrollback as well. |
629 | Shift-Print to include the scrollback as well. |
580 | |
630 | |
|
|
631 | The string will be interpreted as if typed into the shell as-is. |
|
|
632 | |
|
|
633 | Example: |
|
|
634 | |
|
|
635 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
636 | |
|
|
637 | This creates a new file in your home directory with the screen |
|
|
638 | contents everytime you hit "Print". |
|
|
639 | |
581 | scrollBar: *boolean* |
640 | scrollBar: *boolean* |
582 | True: enable the scrollbar [default]; option -sb. False: disable the |
641 | True: enable the scrollbar [default]; option -sb. False: disable the |
583 | scrollbar; option +sb. |
642 | scrollbar; option +sb. |
584 | |
643 | |
585 | scrollBar_right: *boolean* |
644 | scrollBar_right: *boolean* |
… | |
… | |
598 | True: scroll to bottom when tty receives output; option -si. False: |
657 | True: scroll to bottom when tty receives output; option -si. False: |
599 | do not scroll to bottom when tty receives output; option +si. |
658 | do not scroll to bottom when tty receives output; option +si. |
600 | |
659 | |
601 | scrollWithBuffer: *boolean* |
660 | scrollWithBuffer: *boolean* |
602 | True: scroll with scrollback buffer when tty receives new lines (and |
661 | True: scroll with scrollback buffer when tty receives new lines (and |
603 | scrollTtyOutput is False); option +sw. False: do not scroll with |
662 | scrollTtyOutput is False); option -sw. False: do not scroll with |
604 | scrollback buffer when tty recieves new lines; option -sw. |
663 | scrollback buffer when tty recieves new lines; option +sw. |
605 | |
664 | |
606 | scrollTtyKeypress: *boolean* |
665 | scrollTtyKeypress: *boolean* |
607 | True: scroll to bottom when a non-special key is pressed. Special |
666 | True: scroll to bottom when a non-special key is pressed. Special |
608 | keys are those which are intercepted by rxvt-unicode for special |
667 | keys are those which are intercepted by rxvt-unicode for special |
609 | handling and are not passed onto the shell; option -sk. False: do |
668 | handling and are not passed onto the shell; option -sk. False: do |
… | |
… | |
661 | pointerColor2: *colour* |
720 | pointerColor2: *colour* |
662 | Mouse pointer background colour. |
721 | Mouse pointer background colour. |
663 | |
722 | |
664 | pointerBlankDelay: *number* |
723 | pointerBlankDelay: *number* |
665 | Specifies number of seconds before blanking the pointer [default 2]. |
724 | Specifies number of seconds before blanking the pointer [default 2]. |
|
|
725 | Use a large number (e.g. 987654321) to effectively disable the |
|
|
726 | timeout. |
666 | |
727 | |
667 | backspacekey: *string* |
728 | backspacekey: *string* |
668 | The string to send when the backspace key is pressed. If set to DEC |
729 | The string to send when the backspace key is pressed. If set to DEC |
669 | or unset it will send Delete (code 127) or, if shifted, Backspace |
730 | or unset it will send Delete (code 127) or, if shifted, Backspace |
670 | (code 8) - which can be reversed with the appropriate DEC private |
731 | (code 8) - which can be reversed with the appropriate DEC private |
… | |
… | |
786 | is interpreted and executed as rxvt's control sequence. For example |
847 | is interpreted and executed as rxvt's control sequence. For example |
787 | the following means "change the current locale to "zh_CN.GBK" when |
848 | the following means "change the current locale to "zh_CN.GBK" when |
788 | Control-Meta-c is being pressed": |
849 | Control-Meta-c is being pressed": |
789 | |
850 | |
790 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
851 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
852 | |
|
|
853 | Due the the large number of modifier combinations, a defined key |
|
|
854 | mapping will match if at *at least* the specified identifiers are |
|
|
855 | being set, and no other key mappings with those and more bits are |
|
|
856 | being defined. That means that defining a key map for "a" will |
|
|
857 | automatically provide definitions for "Meta-a", "Shift-a" and so on, |
|
|
858 | unless some of those are defined mappings themselves. |
|
|
859 | |
|
|
860 | Unfortunately, this will override built-in key mappings. For example |
|
|
861 | if you overwrite the "Insert" key you will disable rxvt's |
|
|
862 | "Shift-Insert" mapping. To re-enable that, you can poke "holes" into |
|
|
863 | the user-defined keymap using the "builtin:" replacement: |
|
|
864 | |
|
|
865 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
866 | URxvt.keysym.S-Insert: builtin: |
|
|
867 | |
|
|
868 | The first line defines a mapping for "Insert" and *any* combination |
|
|
869 | of modifiers. The second line re-establishes the default mapping for |
|
|
870 | "Shift-Insert". |
791 | |
871 | |
792 | The following example will map Control-Meta-1 and Control-Meta-2 to |
872 | The following example will map Control-Meta-1 and Control-Meta-2 to |
793 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
873 | the fonts "suxuseuro" and "9x15bold", so you can have some limited |
794 | font-switching at runtime: |
874 | font-switching at runtime: |
795 | |
875 | |
… | |
… | |
1005 | Used in the same way as "RXVTPATH". |
1085 | Used in the same way as "RXVTPATH". |
1006 | |
1086 | |
1007 | RXVT_SOCKET |
1087 | RXVT_SOCKET |
1008 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1088 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1009 | |
1089 | |
1010 | Default "$HOME/.rxvt-unicode-<nodename". |
1090 | Default $HOME/.rxvt-unicode-*<nodename*. |
1011 | |
1091 | |
1012 | HOME |
1092 | HOME |
1013 | Used to locate the default directory for the unix domain socket for |
1093 | Used to locate the default directory for the unix domain socket for |
1014 | daemon communications and to locate various resource files (such as |
1094 | daemon communications and to locate various resource files (such as |
1015 | ".Xdefaults") |
1095 | ".Xdefaults") |
… | |
… | |
1024 | FILES |
1104 | FILES |
1025 | /usr/lib/X11/rgb.txt |
1105 | /usr/lib/X11/rgb.txt |
1026 | Color names. |
1106 | Color names. |
1027 | |
1107 | |
1028 | SEE ALSO |
1108 | SEE ALSO |
1029 | rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1109 | rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), |
1030 | |
1110 | tty(4), utmp(5) |
1031 | BUGS |
|
|
1032 | Check the BUGS file for an up-to-date list. |
|
|
1033 | |
|
|
1034 | Cursor change support is not yet implemented. |
|
|
1035 | |
|
|
1036 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1037 | |
1111 | |
1038 | CURRENT PROJECT COORDINATOR |
1112 | CURRENT PROJECT COORDINATOR |
1039 | Project Coordinator |
1113 | Project Coordinator |
1040 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1114 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1041 | |
1115 | |