… | |
… | |
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>. See also the B<-sh> |
123 | option that can be used to brighten or darken the image in addition to |
130 | option that can be used to brighten or darken the image in addition to |
124 | tinting it. |
131 | tinting it; resource I<tintColor>. |
125 | |
132 | |
126 | =item B<-sh> |
133 | =item B<-sh> |
127 | |
134 | |
128 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
135 | 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 |
136 | background image in addition to tinting it (i.e. B<-tint> must be |
… | |
… | |
238 | |
245 | |
239 | Put scrollbar on right/left; resource B<scrollBar_right>. |
246 | Put scrollbar on right/left; resource B<scrollBar_right>. |
240 | |
247 | |
241 | =item B<-st>|B<+st> |
248 | =item B<-st>|B<+st> |
242 | |
249 | |
243 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
250 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
244 | resource B<scrollBar_floating>. |
251 | resource B<scrollBar_floating>. |
245 | |
252 | |
246 | =item B<-ptab>|B<+ptab> |
253 | =item B<-ptab>|B<+ptab> |
247 | |
254 | |
248 | If enabled (default), "Horizontal Tab" characters are being stored as |
255 | If enabled (default), "Horizontal Tab" characters are being stored as |
… | |
… | |
368 | =item B<-ssr>|B<+ssr> |
375 | =item B<-ssr>|B<+ssr> |
369 | |
376 | |
370 | Turn on/off secondary screen scroll (default enabled); resource |
377 | Turn on/off secondary screen scroll (default enabled); resource |
371 | B<secondaryScroll>. |
378 | B<secondaryScroll>. |
372 | |
379 | |
373 | =item B<-keysym.>I<sym>: I<string> |
380 | =item B<-keysym.>I<sym> I<string> |
374 | |
381 | |
375 | Remap a key symbol. See resource B<keysym>. |
382 | Remap a key symbol. See resource B<keysym>. |
376 | |
383 | |
377 | =item B<-embed>: I<windowid> |
384 | =item B<-embed> I<windowid> |
378 | |
385 | |
379 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
386 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
380 | which enables applications to easily embed a terminal. |
387 | which enables applications to easily embed a terminal. |
381 | |
388 | |
382 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
389 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
… | |
… | |
389 | It might be useful to know that @@RXVT_NAME@@ will not close file |
396 | It might be useful to know that @@RXVT_NAME@@ will not close file |
390 | descriptors passed to it (except for stdin/out/err, of course), so you |
397 | descriptors passed to it (except for stdin/out/err, of course), so you |
391 | can use file descriptors to communicate with the programs within the |
398 | can use file descriptors to communicate with the programs within the |
392 | terminal. This works regardless of wether the C<-embed> option was used or |
399 | terminal. This works regardless of wether the C<-embed> option was used or |
393 | not. |
400 | not. |
|
|
401 | |
|
|
402 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
|
|
403 | used (a longer example is in F<doc/embed>): |
|
|
404 | |
|
|
405 | my $rxvt = new Gtk2::Socket; |
|
|
406 | $rxvt->signal_connect_after (realize => sub { |
|
|
407 | my $xid = $_[0]->window->get_xid; |
|
|
408 | system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
409 | }); |
|
|
410 | |
|
|
411 | =item B<-pty-fd> I<fileno> |
|
|
412 | |
|
|
413 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
|
|
414 | pair but instead use the given filehandle as the tty master. This is |
|
|
415 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
416 | without having to run a program within it. |
|
|
417 | |
|
|
418 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
419 | entries and will not tinker with pty/tty permissions - you have to do that |
|
|
420 | yourself if you want that. |
|
|
421 | |
|
|
422 | Here is a example in perl that illustrates how this option can be used (a |
|
|
423 | longer example is in F<doc/pty-fd>): |
|
|
424 | |
|
|
425 | use IO::Pty; |
|
|
426 | use Fcntl; |
|
|
427 | |
|
|
428 | my $pty = new IO::Pty; |
|
|
429 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
430 | system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
431 | close $pty; |
|
|
432 | |
|
|
433 | # now communicate with rxvt |
|
|
434 | my $slave = $pty->slave; |
|
|
435 | while (<$slave>) { print $slave "got <$_>\n" } |
394 | |
436 | |
395 | =back |
437 | =back |
396 | |
438 | |
397 | =head1 RESOURCES (available also as long-options) |
439 | =head1 RESOURCES (available also as long-options) |
398 | |
440 | |
… | |
… | |
513 | artificial transparency. B<False>: do not inherit the parent windows' |
555 | artificial transparency. B<False>: do not inherit the parent windows' |
514 | pixmap. |
556 | pixmap. |
515 | |
557 | |
516 | =item B<fading:> I<number> |
558 | =item B<fading:> I<number> |
517 | |
559 | |
518 | Fade the text by the given percentage when focus is lost. |
560 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
|
|
561 | |
|
|
562 | =item B<fadeColor:> I<colour> |
|
|
563 | |
|
|
564 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
565 | colour is black; option B<-fadecolor>. |
519 | |
566 | |
520 | =item B<tintColor:> I<colour> |
567 | =item B<tintColor:> I<colour> |
521 | |
568 | |
522 | Tint the transparent background pixmap with the given colour. |
569 | Tint the transparent background pixmap with the given colour; option |
|
|
570 | B<-tint>. |
523 | |
571 | |
524 | =item B<shading:> I<number> |
572 | =item B<shading:> I<number> |
525 | |
573 | |
526 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
574 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
527 | image in addition to tinting it. |
575 | image in addition to tinting it. |
… | |
… | |
531 | Use the specified colour for the scrollbar [default #B2B2B2]. |
579 | Use the specified colour for the scrollbar [default #B2B2B2]. |
532 | |
580 | |
533 | =item B<troughColor:> I<colour> |
581 | =item B<troughColor:> I<colour> |
534 | |
582 | |
535 | Use the specified colour for the scrollbar's trough area [default |
583 | Use the specified colour for the scrollbar's trough area [default |
536 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
584 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
537 | |
585 | |
538 | =item B<borderColor:> I<colour> |
586 | =item B<borderColor:> I<colour> |
539 | |
587 | |
540 | The colour of the border around the text area and between the scrollbar |
588 | The colour of the border around the text area and between the scrollbar |
541 | and the text. |
589 | and the text. |
… | |
… | |
633 | xterm style selection. |
681 | xterm style selection. |
634 | |
682 | |
635 | =item B<scrollstyle:> I<mode> |
683 | =item B<scrollstyle:> I<mode> |
636 | |
684 | |
637 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
685 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
638 | the author's favourite.. |
686 | the author's favourite. |
639 | |
687 | |
640 | =item B<title:> I<string> |
688 | =item B<title:> I<string> |
641 | |
689 | |
642 | Set window title string, the default title is the command-line |
690 | Set window title string, the default title is the command-line |
643 | specified after the B<-e> option, if any, otherwise the application |
691 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
675 | |
723 | |
676 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
724 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
677 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
725 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
678 | B<Shift-Print> to include the scrollback as well. |
726 | B<Shift-Print> to include the scrollback as well. |
679 | |
727 | |
|
|
728 | The string will be interpreted as if typed into the shell as-is. |
|
|
729 | |
|
|
730 | Example: |
|
|
731 | |
|
|
732 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
733 | |
|
|
734 | This creates a new file in your home directory with the screen contents |
|
|
735 | everytime you hit C<Print>. |
|
|
736 | |
680 | =item B<scrollBar:> I<boolean> |
737 | =item B<scrollBar:> I<boolean> |
681 | |
738 | |
682 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
739 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
683 | disable the scrollbar; option B<+sb>. |
740 | disable the scrollbar; option B<+sb>. |
684 | |
741 | |
… | |
… | |
704 | B<+si>. |
761 | B<+si>. |
705 | |
762 | |
706 | =item B<scrollWithBuffer:> I<boolean> |
763 | =item B<scrollWithBuffer:> I<boolean> |
707 | |
764 | |
708 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
765 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
709 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
766 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
710 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
767 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
711 | |
768 | |
712 | =item B<scrollTtyKeypress:> I<boolean> |
769 | =item B<scrollTtyKeypress:> I<boolean> |
713 | |
770 | |
714 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
771 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
715 | are those which are intercepted by rxvt-unicode for special handling and |
772 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
780 | |
837 | |
781 | Mouse pointer background colour. |
838 | Mouse pointer background colour. |
782 | |
839 | |
783 | =item B<pointerBlankDelay:> I<number> |
840 | =item B<pointerBlankDelay:> I<number> |
784 | |
841 | |
785 | Specifies number of seconds before blanking the pointer [default 2]. |
842 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
843 | large number (e.g. C<987654321>) to effectively disable the timeout. |
786 | |
844 | |
787 | =item B<backspacekey:> I<string> |
845 | =item B<backspacekey:> I<string> |
788 | |
846 | |
789 | The string to send when the backspace key is pressed. If set to B<DEC> |
847 | The string to send when the backspace key is pressed. If set to B<DEC> |
790 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
848 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
… | |
… | |
921 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
979 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
922 | example the following means "change the current locale to C<zh_CN.GBK> |
980 | example the following means "change the current locale to C<zh_CN.GBK> |
923 | when Control-Meta-c is being pressed": |
981 | when Control-Meta-c is being pressed": |
924 | |
982 | |
925 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
983 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
984 | |
|
|
985 | Due the the large number of modifier combinations, a defined key mapping |
|
|
986 | will match if at I<at least> the specified identifiers are being set, and |
|
|
987 | no other key mappings with those and more bits are being defined. That |
|
|
988 | means that defining a key map for C<a> will automatically provide |
|
|
989 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
990 | mappings themselves. |
|
|
991 | |
|
|
992 | Unfortunately, this will override built-in key mappings. For example |
|
|
993 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
|
|
994 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
|
|
995 | user-defined keymap using the C<builtin:> replacement: |
|
|
996 | |
|
|
997 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
998 | URxvt.keysym.S-Insert: builtin: |
|
|
999 | |
|
|
1000 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
1001 | of modifiers. The second line re-establishes the default mapping for |
|
|
1002 | C<Shift-Insert>. |
926 | |
1003 | |
927 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1004 | The following example will map Control-Meta-1 and Control-Meta-2 to |
928 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1005 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
929 | font-switching at runtime: |
1006 | font-switching at runtime: |
930 | |
1007 | |
… | |
… | |
1183 | =item B<RXVT_SOCKET> |
1260 | =item B<RXVT_SOCKET> |
1184 | |
1261 | |
1185 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1262 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1186 | @@RXVT_NAME@@d(1). |
1263 | @@RXVT_NAME@@d(1). |
1187 | |
1264 | |
1188 | Default C<< $HOME/.rxvt-unicode-<nodename >>. |
1265 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1189 | |
1266 | |
1190 | =item B<HOME> |
1267 | =item B<HOME> |
1191 | |
1268 | |
1192 | Used to locate the default directory for the unix domain socket for |
1269 | Used to locate the default directory for the unix domain socket for |
1193 | daemon communications and to locate various resource files (such as |
1270 | daemon communications and to locate various resource files (such as |
… | |
… | |
1214 | |
1291 | |
1215 | =back |
1292 | =back |
1216 | |
1293 | |
1217 | =head1 SEE ALSO |
1294 | =head1 SEE ALSO |
1218 | |
1295 | |
1219 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1296 | @@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) |
1220 | |
1297 | |
1221 | =head1 BUGS |
1298 | =head1 BUGS |
1222 | |
1299 | |
1223 | Check the BUGS file for an up-to-date list. |
1300 | Check the BUGS file for an up-to-date list. |
1224 | |
1301 | |