ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.61 by root, Sat Feb 19 01:07:57 2005 UTC

368=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
369 369
370Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 371B<secondaryScroll>.
372 372
373=item B<-keysym.>I<sym>: I<string> 373=item B<-keysym.>I<sym> I<string>
374 374
375Remap a key symbol. See resource B<keysym>. 375Remap a key symbol. See resource B<keysym>.
376 376
377=item B<-embed>: I<windowid> 377=item B<-embed> I<windowid>
378 378
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380which enables applications to easily embed a terminal. 380which enables applications to easily embed a terminal.
381 381
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to 384quite a bit, so don't expect it to keep some specific state. It's best to
385create an extra subwindow for @@RXVT_NAME@@ and leave it alone. 385create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386
387The window will not be destroyed when @@RXVT_NAME@@ exits.
386 388
387It might be useful to know that @@RXVT_NAME@@ will not close file 389It might be useful to know that @@RXVT_NAME@@ will not close file
388descriptors passed to it (except for stdin/out/err, of course), so you 390descriptors passed to it (except for stdin/out/err, of course), so you
389can use file descriptors to communicate with the programs within the 391can use file descriptors to communicate with the programs within the
390terminal. This works regardless of wether the C<-embed> option was used or 392terminal. This works regardless of wether the C<-embed> option was used or
391not. 393not.
394
395Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (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
406Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407pair but instead use the given filehandle as the tty master. This is
408useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409without having to run a program within it.
410
411If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412entries and will not tinker with pty/tty permissions - you have to do that
413yourself if you want that.
414
415Here is a example in perl that illustrates how this option can be used (a
416longer 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" }
392 429
393=back 430=back
394 431
395=head1 RESOURCES (available also as long-options) 432=head1 RESOURCES (available also as long-options)
396 433
702B<+si>. 739B<+si>.
703 740
704=item B<scrollWithBuffer:> I<boolean> 741=item B<scrollWithBuffer:> I<boolean>
705 742
706B<True>: scroll with scrollback buffer when tty receives new lines (and 743B<True>: scroll with scrollback buffer when tty receives new lines (and
707B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 744B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
708with scrollback buffer when tty recieves new lines; option B<-sw>. 745with scrollback buffer when tty recieves new lines; option B<+sw>.
709 746
710=item B<scrollTtyKeypress:> I<boolean> 747=item B<scrollTtyKeypress:> I<boolean>
711 748
712B<True>: scroll to bottom when a non-special key is pressed. Special keys 749B<True>: scroll to bottom when a non-special key is pressed. Special keys
713are those which are intercepted by rxvt-unicode for special handling and 750are those which are intercepted by rxvt-unicode for special handling and

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines