… | |
… | |
105 | |
105 | |
106 | =item B<-j>|B<+j> |
106 | =item B<-j>|B<+j> |
107 | |
107 | |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
109 | |
109 | |
110 | =item B<-ip>|B<+ip> |
110 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
111 | |
111 | |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
113 | B<-tr>; resource B<inheritPixmap>. |
113 | B<-tr>; resource B<inheritPixmap>. |
114 | |
114 | |
115 | =item B<-fade> I<number> |
115 | =item B<-fade> I<number> |
116 | |
116 | |
117 | Fade the text by the given percentage when focus is lost. resource B<fading>. |
117 | Fade the text by the given percentage when focus is lost. Small values |
|
|
118 | fade a little only, 100 completely replaces all colours by the fade |
|
|
119 | colour; resource B<fading>. |
|
|
120 | |
|
|
121 | =item B<-fadecolor> I<colour> |
|
|
122 | |
|
|
123 | Fade to this colour when fading is used (see B<-fade>). The default colour |
|
|
124 | is black. resource B<fadeColor>. |
118 | |
125 | |
119 | =item B<-tint> I<colour> |
126 | =item B<-tint> I<colour> |
120 | |
127 | |
121 | Tint the transparent background pixmap with the given colour when |
128 | Tint the transparent background pixmap with the given colour when |
122 | transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
129 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
123 | option that can be used to brighten or darken the image in addition to |
130 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
124 | tinting it. |
131 | used to brighten or darken the image in addition to tinting it; resource |
|
|
132 | I<tintColor>. Example: |
|
|
133 | |
|
|
134 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
125 | |
135 | |
126 | =item B<-sh> |
136 | =item B<-sh> |
127 | |
137 | |
128 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
129 | background image in addition to tinting it (i.e. B<-tint> must be |
139 | background image in addition to tinting it (i.e. B<-tint> must be |
… | |
… | |
238 | |
248 | |
239 | Put scrollbar on right/left; resource B<scrollBar_right>. |
249 | Put scrollbar on right/left; resource B<scrollBar_right>. |
240 | |
250 | |
241 | =item B<-st>|B<+st> |
251 | =item B<-st>|B<+st> |
242 | |
252 | |
243 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
253 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
244 | resource B<scrollBar_floating>. |
254 | resource B<scrollBar_floating>. |
245 | |
255 | |
246 | =item B<-ptab>|B<+ptab> |
256 | =item B<-ptab>|B<+ptab> |
247 | |
257 | |
248 | If enabled (default), "Horizontal Tab" characters are being stored as |
258 | If enabled (default), "Horizontal Tab" characters are being stored as |
… | |
… | |
368 | =item B<-ssr>|B<+ssr> |
378 | =item B<-ssr>|B<+ssr> |
369 | |
379 | |
370 | Turn on/off secondary screen scroll (default enabled); resource |
380 | Turn on/off secondary screen scroll (default enabled); resource |
371 | B<secondaryScroll>. |
381 | B<secondaryScroll>. |
372 | |
382 | |
373 | =item B<-keysym.>I<sym>: I<string> |
383 | =item B<-keysym.>I<sym> I<string> |
374 | |
384 | |
375 | Remap a key symbol. See resource B<keysym>. |
385 | Remap a key symbol. See resource B<keysym>. |
376 | |
386 | |
377 | =item B<-xrm> I<resourcestring> |
387 | =item B<-embed> I<windowid> |
378 | |
388 | |
379 | No effect on rxvt-unicode. Simply passes through an argument to be made |
389 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
380 | available in the instance's argument list. Appears in I<WM_COMMAND> in |
390 | which enables applications to easily embed a terminal. |
381 | some window managers. |
391 | |
|
|
392 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
|
|
393 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
|
|
394 | quite a bit, so don't expect it to keep some specific state. It's best to |
|
|
395 | create an extra subwindow for @@RXVT_NAME@@ and leave it alone. |
|
|
396 | |
|
|
397 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
|
|
398 | |
|
|
399 | It might be useful to know that @@RXVT_NAME@@ will not close file |
|
|
400 | descriptors passed to it (except for stdin/out/err, of course), so you |
|
|
401 | can use file descriptors to communicate with the programs within the |
|
|
402 | terminal. This works regardless of wether the C<-embed> option was used or |
|
|
403 | not. |
|
|
404 | |
|
|
405 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
|
|
406 | used (a longer example is in F<doc/embed>): |
|
|
407 | |
|
|
408 | my $rxvt = new Gtk2::Socket; |
|
|
409 | $rxvt->signal_connect_after (realize => sub { |
|
|
410 | my $xid = $_[0]->window->get_xid; |
|
|
411 | system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
412 | }); |
|
|
413 | |
|
|
414 | =item B<-pty-fd> I<fileno> |
|
|
415 | |
|
|
416 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
|
|
417 | pair but instead use the given filehandle as the tty master. This is |
|
|
418 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
419 | without having to run a program within it. |
|
|
420 | |
|
|
421 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
422 | entries and will not tinker with pty/tty permissions - you have to do that |
|
|
423 | yourself if you want that. |
|
|
424 | |
|
|
425 | Here is a example in perl that illustrates how this option can be used (a |
|
|
426 | longer example is in F<doc/pty-fd>): |
|
|
427 | |
|
|
428 | use IO::Pty; |
|
|
429 | use Fcntl; |
|
|
430 | |
|
|
431 | my $pty = new IO::Pty; |
|
|
432 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
433 | system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
434 | close $pty; |
|
|
435 | |
|
|
436 | # now communicate with rxvt |
|
|
437 | my $slave = $pty->slave; |
|
|
438 | while (<$slave>) { print $slave "got <$_>\n" } |
382 | |
439 | |
383 | =back |
440 | =back |
384 | |
441 | |
385 | =head1 RESOURCES (available also as long-options) |
442 | =head1 RESOURCES (available also as long-options) |
386 | |
443 | |
… | |
… | |
501 | artificial transparency. B<False>: do not inherit the parent windows' |
558 | artificial transparency. B<False>: do not inherit the parent windows' |
502 | pixmap. |
559 | pixmap. |
503 | |
560 | |
504 | =item B<fading:> I<number> |
561 | =item B<fading:> I<number> |
505 | |
562 | |
506 | Fade the text by the given percentage when focus is lost. |
563 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
|
|
564 | |
|
|
565 | =item B<fadeColor:> I<colour> |
|
|
566 | |
|
|
567 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
568 | colour is black; option B<-fadecolor>. |
507 | |
569 | |
508 | =item B<tintColor:> I<colour> |
570 | =item B<tintColor:> I<colour> |
509 | |
571 | |
510 | Tint the transparent background pixmap with the given colour. |
572 | Tint the transparent background pixmap with the given colour; option |
|
|
573 | B<-tint>. |
511 | |
574 | |
512 | =item B<shading:> I<number> |
575 | =item B<shading:> I<number> |
513 | |
576 | |
514 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
577 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
515 | image in addition to tinting it. |
578 | image in addition to tinting it. |
… | |
… | |
519 | Use the specified colour for the scrollbar [default #B2B2B2]. |
582 | Use the specified colour for the scrollbar [default #B2B2B2]. |
520 | |
583 | |
521 | =item B<troughColor:> I<colour> |
584 | =item B<troughColor:> I<colour> |
522 | |
585 | |
523 | Use the specified colour for the scrollbar's trough area [default |
586 | Use the specified colour for the scrollbar's trough area [default |
524 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
587 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
525 | |
588 | |
526 | =item B<borderColor:> I<colour> |
589 | =item B<borderColor:> I<colour> |
527 | |
590 | |
528 | The colour of the border around the text area and between the scrollbar |
591 | The colour of the border around the text area and between the scrollbar |
529 | and the text. |
592 | and the text. |
… | |
… | |
621 | xterm style selection. |
684 | xterm style selection. |
622 | |
685 | |
623 | =item B<scrollstyle:> I<mode> |
686 | =item B<scrollstyle:> I<mode> |
624 | |
687 | |
625 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
688 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
626 | the author's favourite.. |
689 | the author's favourite. |
627 | |
690 | |
628 | =item B<title:> I<string> |
691 | =item B<title:> I<string> |
629 | |
692 | |
630 | Set window title string, the default title is the command-line |
693 | Set window title string, the default title is the command-line |
631 | specified after the B<-e> option, if any, otherwise the application |
694 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
663 | |
726 | |
664 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
727 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
665 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
728 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
666 | B<Shift-Print> to include the scrollback as well. |
729 | B<Shift-Print> to include the scrollback as well. |
667 | |
730 | |
|
|
731 | The string will be interpreted as if typed into the shell as-is. |
|
|
732 | |
|
|
733 | Example: |
|
|
734 | |
|
|
735 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
736 | |
|
|
737 | This creates a new file in your home directory with the screen contents |
|
|
738 | everytime you hit C<Print>. |
|
|
739 | |
668 | =item B<scrollBar:> I<boolean> |
740 | =item B<scrollBar:> I<boolean> |
669 | |
741 | |
670 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
742 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
671 | disable the scrollbar; option B<+sb>. |
743 | disable the scrollbar; option B<+sb>. |
672 | |
744 | |
… | |
… | |
692 | B<+si>. |
764 | B<+si>. |
693 | |
765 | |
694 | =item B<scrollWithBuffer:> I<boolean> |
766 | =item B<scrollWithBuffer:> I<boolean> |
695 | |
767 | |
696 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
768 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
697 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
769 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
698 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
770 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
699 | |
771 | |
700 | =item B<scrollTtyKeypress:> I<boolean> |
772 | =item B<scrollTtyKeypress:> I<boolean> |
701 | |
773 | |
702 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
774 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
703 | are those which are intercepted by rxvt-unicode for special handling and |
775 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
768 | |
840 | |
769 | Mouse pointer background colour. |
841 | Mouse pointer background colour. |
770 | |
842 | |
771 | =item B<pointerBlankDelay:> I<number> |
843 | =item B<pointerBlankDelay:> I<number> |
772 | |
844 | |
773 | Specifies number of seconds before blanking the pointer [default 2]. |
845 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
846 | large number (e.g. C<987654321>) to effectively disable the timeout. |
774 | |
847 | |
775 | =item B<backspacekey:> I<string> |
848 | =item B<backspacekey:> I<string> |
776 | |
849 | |
777 | The string to send when the backspace key is pressed. If set to B<DEC> |
850 | The string to send when the backspace key is pressed. If set to B<DEC> |
778 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
851 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
… | |
… | |
825 | =item B<insecure:> I<boolean> |
898 | =item B<insecure:> I<boolean> |
826 | |
899 | |
827 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
900 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
828 | echo arbitrary strings like the icon name or the locale. This could be |
901 | echo arbitrary strings like the icon name or the locale. This could be |
829 | abused if somebody gets 8-bit-clean access to your display, whether |
902 | abused if somebody gets 8-bit-clean access to your display, whether |
830 | throuh a mail client displaying mail bodies unfiltered or though |
903 | through a mail client displaying mail bodies unfiltered or through |
831 | write(1). Therefore, these sequences are disabled by default. (Note |
904 | write(1) or any other means. Therefore, these sequences are disabled by |
832 | that other terminals, including xterm, have these sequences |
905 | default. (Note that many other terminals, including xterm, have these |
833 | enabled by default). You can enable them by setting this boolean |
906 | sequences enabled by default, which doesn't make it safer, though). |
834 | resource or specifying B<-insecure> as an option. At the moment, this |
907 | |
835 | enabled display-answer, locale, findfont, icon label and window title |
908 | You can enable them by setting this boolean resource or specifying |
836 | requests as well as dynamic menubar dispatch. |
909 | B<-insecure> as an option. At the moment, this enables display-answer, |
|
|
910 | locale, findfont, icon label and window title requests as well as dynamic |
|
|
911 | menubar dispatch. |
837 | |
912 | |
838 | =item B<modifier:> I<modifier> |
913 | =item B<modifier:> I<modifier> |
839 | |
914 | |
840 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
915 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
841 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
916 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
909 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
984 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
910 | example the following means "change the current locale to C<zh_CN.GBK> |
985 | example the following means "change the current locale to C<zh_CN.GBK> |
911 | when Control-Meta-c is being pressed": |
986 | when Control-Meta-c is being pressed": |
912 | |
987 | |
913 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
988 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
989 | |
|
|
990 | Due the the large number of modifier combinations, a defined key mapping |
|
|
991 | will match if at I<at least> the specified identifiers are being set, and |
|
|
992 | no other key mappings with those and more bits are being defined. That |
|
|
993 | means that defining a key map for C<a> will automatically provide |
|
|
994 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
995 | mappings themselves. |
|
|
996 | |
|
|
997 | Unfortunately, this will override built-in key mappings. For example |
|
|
998 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
|
|
999 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
|
|
1000 | user-defined keymap using the C<builtin:> replacement: |
|
|
1001 | |
|
|
1002 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
1003 | URxvt.keysym.S-Insert: builtin: |
|
|
1004 | |
|
|
1005 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
1006 | of modifiers. The second line re-establishes the default mapping for |
|
|
1007 | C<Shift-Insert>. |
914 | |
1008 | |
915 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1009 | The following example will map Control-Meta-1 and Control-Meta-2 to |
916 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1010 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
917 | font-switching at runtime: |
1011 | font-switching at runtime: |
918 | |
1012 | |
… | |
… | |
985 | supported in rxvt-unicode. Bug me if you need this. |
1079 | supported in rxvt-unicode. Bug me if you need this. |
986 | |
1080 | |
987 | You can, however, switch fonts at runtime using escape sequences (and |
1081 | You can, however, switch fonts at runtime using escape sequences (and |
988 | therefore using the menubar), e.g.: |
1082 | therefore using the menubar), e.g.: |
989 | |
1083 | |
990 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1084 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
991 | |
1085 | |
992 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1086 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
993 | |
1087 | |
994 | =head1 ISO 14755 SUPPORT |
1088 | =head1 ISO 14755 SUPPORT |
995 | |
1089 | |
… | |
… | |
1171 | =item B<RXVT_SOCKET> |
1265 | =item B<RXVT_SOCKET> |
1172 | |
1266 | |
1173 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1267 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1174 | @@RXVT_NAME@@d(1). |
1268 | @@RXVT_NAME@@d(1). |
1175 | |
1269 | |
1176 | Default C<< $HOME/.rxvt-unicode-<nodename >>. |
1270 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1177 | |
1271 | |
1178 | =item B<HOME> |
1272 | =item B<HOME> |
1179 | |
1273 | |
1180 | Used to locate the default directory for the unix domain socket for |
1274 | Used to locate the default directory for the unix domain socket for |
1181 | daemon communications and to locate various resource files (such as |
1275 | daemon communications and to locate various resource files (such as |
… | |
… | |
1202 | |
1296 | |
1203 | =back |
1297 | =back |
1204 | |
1298 | |
1205 | =head1 SEE ALSO |
1299 | =head1 SEE ALSO |
1206 | |
1300 | |
1207 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1301 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1208 | |
|
|
1209 | =head1 BUGS |
|
|
1210 | |
|
|
1211 | Check the BUGS file for an up-to-date list. |
|
|
1212 | |
|
|
1213 | Cursor change support is not yet implemented. |
|
|
1214 | |
|
|
1215 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1216 | |
1302 | |
1217 | =head1 CURRENT PROJECT COORDINATOR |
1303 | =head1 CURRENT PROJECT COORDINATOR |
1218 | |
1304 | |
1219 | =over 4 |
1305 | =over 4 |
1220 | |
1306 | |