| … | |
… | |
| 238 | |
238 | |
| 239 | Put scrollbar on right/left; resource B<scrollBar_right>. |
239 | Put scrollbar on right/left; resource B<scrollBar_right>. |
| 240 | |
240 | |
| 241 | =item B<-st>|B<+st> |
241 | =item B<-st>|B<+st> |
| 242 | |
242 | |
| 243 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
243 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
| 244 | resource B<scrollBar_floating>. |
244 | resource B<scrollBar_floating>. |
| 245 | |
245 | |
| 246 | =item B<-ptab>|B<+ptab> |
246 | =item B<-ptab>|B<+ptab> |
| 247 | |
247 | |
| 248 | If enabled (default), "Horizontal Tab" characters are being stored as |
248 | If enabled (default), "Horizontal Tab" characters are being stored as |
| … | |
… | |
| 368 | =item B<-ssr>|B<+ssr> |
368 | =item B<-ssr>|B<+ssr> |
| 369 | |
369 | |
| 370 | Turn on/off secondary screen scroll (default enabled); resource |
370 | Turn on/off secondary screen scroll (default enabled); resource |
| 371 | B<secondaryScroll>. |
371 | B<secondaryScroll>. |
| 372 | |
372 | |
| 373 | =item B<-keysym.>I<sym>: I<string> |
373 | =item B<-keysym.>I<sym> I<string> |
| 374 | |
374 | |
| 375 | Remap a key symbol. See resource B<keysym>. |
375 | Remap a key symbol. See resource B<keysym>. |
| 376 | |
376 | |
| 377 | =item B<-xrm> I<resourcestring> |
377 | =item B<-embed> I<windowid> |
| 378 | |
378 | |
| 379 | No effect on rxvt-unicode. Simply passes through an argument to be made |
379 | 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 |
380 | which enables applications to easily embed a terminal. |
| 381 | some window managers. |
381 | |
|
|
382 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
|
|
383 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
|
|
384 | quite a bit, so don't expect it to keep some specific state. It's best to |
|
|
385 | create an extra subwindow for @@RXVT_NAME@@ and leave it alone. |
|
|
386 | |
|
|
387 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
|
|
388 | |
|
|
389 | 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 |
|
|
391 | 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 |
|
|
393 | not. |
|
|
394 | |
|
|
395 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
|
|
396 | used (a longer example is in F<doc/embed>): |
|
|
397 | |
|
|
398 | my $rxvt = new Gtk2::Socket; |
|
|
399 | $rxvt->signal_connect_after (realize => sub { |
|
|
400 | my $xid = $_[0]->window->get_xid; |
|
|
401 | system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
402 | }); |
|
|
403 | |
|
|
404 | =item B<-pty-fd> I<fileno> |
|
|
405 | |
|
|
406 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
|
|
407 | pair but instead use the given filehandle as the tty master. This is |
|
|
408 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
409 | without having to run a program within it. |
|
|
410 | |
|
|
411 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
412 | entries and will not tinker with pty/tty permissions - you have to do that |
|
|
413 | yourself if you want that. |
|
|
414 | |
|
|
415 | Here is a example in perl that illustrates how this option can be used (a |
|
|
416 | longer example is in F<doc/pty-fd>): |
|
|
417 | |
|
|
418 | use IO::Pty; |
|
|
419 | use Fcntl; |
|
|
420 | |
|
|
421 | my $pty = new IO::Pty; |
|
|
422 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
423 | system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
424 | close $pty; |
|
|
425 | |
|
|
426 | # now communicate with rxvt |
|
|
427 | my $slave = $pty->slave; |
|
|
428 | while (<$slave>) { print $slave "got <$_>\n" } |
| 382 | |
429 | |
| 383 | =back |
430 | =back |
| 384 | |
431 | |
| 385 | =head1 RESOURCES (available also as long-options) |
432 | =head1 RESOURCES (available also as long-options) |
| 386 | |
433 | |
| … | |
… | |
| 519 | Use the specified colour for the scrollbar [default #B2B2B2]. |
566 | Use the specified colour for the scrollbar [default #B2B2B2]. |
| 520 | |
567 | |
| 521 | =item B<troughColor:> I<colour> |
568 | =item B<troughColor:> I<colour> |
| 522 | |
569 | |
| 523 | Use the specified colour for the scrollbar's trough area [default |
570 | Use the specified colour for the scrollbar's trough area [default |
| 524 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
571 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
| 525 | |
572 | |
| 526 | =item B<borderColor:> I<colour> |
573 | =item B<borderColor:> I<colour> |
| 527 | |
574 | |
| 528 | The colour of the border around the text area and between the scrollbar |
575 | The colour of the border around the text area and between the scrollbar |
| 529 | and the text. |
576 | and the text. |
| … | |
… | |
| 621 | xterm style selection. |
668 | xterm style selection. |
| 622 | |
669 | |
| 623 | =item B<scrollstyle:> I<mode> |
670 | =item B<scrollstyle:> I<mode> |
| 624 | |
671 | |
| 625 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
672 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
| 626 | the author's favourite.. |
673 | the author's favourite. |
| 627 | |
674 | |
| 628 | =item B<title:> I<string> |
675 | =item B<title:> I<string> |
| 629 | |
676 | |
| 630 | Set window title string, the default title is the command-line |
677 | Set window title string, the default title is the command-line |
| 631 | specified after the B<-e> option, if any, otherwise the application |
678 | specified after the B<-e> option, if any, otherwise the application |
| … | |
… | |
| 663 | |
710 | |
| 664 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
711 | 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 |
712 | 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. |
713 | B<Shift-Print> to include the scrollback as well. |
| 667 | |
714 | |
|
|
715 | The string will be interpreted as if typed into the shell as-is. |
|
|
716 | |
|
|
717 | Example: |
|
|
718 | |
|
|
719 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
720 | |
|
|
721 | This creates a new file in your home directory with the screen contents |
|
|
722 | everytime you hit C<Print>. |
|
|
723 | |
| 668 | =item B<scrollBar:> I<boolean> |
724 | =item B<scrollBar:> I<boolean> |
| 669 | |
725 | |
| 670 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
726 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
| 671 | disable the scrollbar; option B<+sb>. |
727 | disable the scrollbar; option B<+sb>. |
| 672 | |
728 | |
| … | |
… | |
| 692 | B<+si>. |
748 | B<+si>. |
| 693 | |
749 | |
| 694 | =item B<scrollWithBuffer:> I<boolean> |
750 | =item B<scrollWithBuffer:> I<boolean> |
| 695 | |
751 | |
| 696 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
752 | 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 |
753 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
| 698 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
754 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
| 699 | |
755 | |
| 700 | =item B<scrollTtyKeypress:> I<boolean> |
756 | =item B<scrollTtyKeypress:> I<boolean> |
| 701 | |
757 | |
| 702 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
758 | 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 |
759 | are those which are intercepted by rxvt-unicode for special handling and |
| … | |
… | |
| 768 | |
824 | |
| 769 | Mouse pointer background colour. |
825 | Mouse pointer background colour. |
| 770 | |
826 | |
| 771 | =item B<pointerBlankDelay:> I<number> |
827 | =item B<pointerBlankDelay:> I<number> |
| 772 | |
828 | |
| 773 | Specifies number of seconds before blanking the pointer [default 2]. |
829 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
830 | large number (e.g. C<987654321>) to effectively disable the timeout. |
| 774 | |
831 | |
| 775 | =item B<backspacekey:> I<string> |
832 | =item B<backspacekey:> I<string> |
| 776 | |
833 | |
| 777 | The string to send when the backspace key is pressed. If set to B<DEC> |
834 | 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> |
835 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
| … | |
… | |
| 909 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
966 | 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> |
967 | example the following means "change the current locale to C<zh_CN.GBK> |
| 911 | when Control-Meta-c is being pressed": |
968 | when Control-Meta-c is being pressed": |
| 912 | |
969 | |
| 913 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
970 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
971 | |
|
|
972 | Due the the large number of modifier combinations, a defined key mapping |
|
|
973 | will match if at I<at least> the specified identifiers are being set, and |
|
|
974 | no other key mappings with those and more bits are being defined. That |
|
|
975 | means that defining a key map for C<a> will automatically provide |
|
|
976 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
977 | mappings themselves. |
|
|
978 | |
|
|
979 | Unfortunately, this will override built-in key mappings. For example |
|
|
980 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
|
|
981 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
|
|
982 | user-defined keymap using the C<builtin:> replacement: |
|
|
983 | |
|
|
984 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
985 | URxvt.keysym.S-Insert: builtin: |
|
|
986 | |
|
|
987 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
988 | of modifiers. The second line re-establishes the default mapping for |
|
|
989 | C<Shift-Insert>. |
| 914 | |
990 | |
| 915 | The following example will map Control-Meta-1 and Control-Meta-2 to |
991 | 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 |
992 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
| 917 | font-switching at runtime: |
993 | font-switching at runtime: |
| 918 | |
994 | |
| … | |
… | |
| 1134 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1210 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
| 1135 | the colour code used as default foreground/text colour (or the string |
1211 | the colour code used as default foreground/text colour (or the string |
| 1136 | C<default> to indicate that the default-colour escape sequence is to be |
1212 | C<default> to indicate that the default-colour escape sequence is to be |
| 1137 | used), C<bg> is the colour code used as default background colour (or the |
1213 | used), C<bg> is the colour code used as default background colour (or the |
| 1138 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1214 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
| 1139 | was compiled with XPM support. Libraries like C<slang> can (and do) use |
1215 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
| 1140 | this information to optimize screen output. |
1216 | (and do) use this information to optimize screen output. |
| 1141 | |
1217 | |
| 1142 | =item B<WINDOWID> |
1218 | =item B<WINDOWID> |
| 1143 | |
1219 | |
| 1144 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1220 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
| 1145 | window, which usually has subwindows for the scrollbar, the terminal |
1221 | window, which usually has subwindows for the scrollbar, the terminal |
| … | |
… | |
| 1218 | |
1294 | |
| 1219 | =over 4 |
1295 | =over 4 |
| 1220 | |
1296 | |
| 1221 | =item Project Coordinator |
1297 | =item Project Coordinator |
| 1222 | |
1298 | |
| 1223 | @@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> |
1299 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
| 1224 | |
1300 | |
| 1225 | L<@@RXVT_WEBPAGE@@> |
1301 | L<http://software.schmorp.de/#rxvt-unicode> |
| 1226 | |
1302 | |
| 1227 | =back |
1303 | =back |
| 1228 | |
1304 | |
| 1229 | =head1 AUTHORS |
1305 | =head1 AUTHORS |
| 1230 | |
1306 | |
| … | |
… | |
| 1255 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1331 | =item Geoff Wing L<< <gcw@pobox.com> >> |
| 1256 | |
1332 | |
| 1257 | Rewrote screen display and text selection routines. Project Coordinator |
1333 | Rewrote screen display and text selection routines. Project Coordinator |
| 1258 | (changes.txt 2.4.6 - rxvt-unicode) |
1334 | (changes.txt 2.4.6 - rxvt-unicode) |
| 1259 | |
1335 | |
| 1260 | =item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> |
1336 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
| 1261 | |
1337 | |
| 1262 | Forked rxvt-unicode, rewrote most of the display code and internal |
1338 | Forked rxvt-unicode, rewrote most of the display code and internal |
| 1263 | character handling to store text in unicode, improve xterm |
1339 | character handling to store text in unicode, improve xterm |
| 1264 | compatibility and apply numerous other bugfixes and extensions. |
1340 | compatibility and apply numerous other bugfixes and extensions. |
| 1265 | |
1341 | |
