--- rxvt-unicode/doc/rxvt.1.pod 2005/02/11 18:14:07 1.53 +++ rxvt-unicode/doc/rxvt.1.pod 2005/02/17 15:07:48 1.59 @@ -370,15 +370,63 @@ Turn on/off secondary screen scroll (default enabled); resource B. -=item B<-keysym.>I: I +=item B<-keysym.>I I Remap a key symbol. See resource B. -=item B<-xrm> I +=item B<-embed> I -No effect on rxvt-unicode. Simply passes through an argument to be made -available in the instance's argument list. Appears in I in -some window managers. +Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, +which enables applications to easily embed a terminal. + +Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it +shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it +quite a bit, so don't expect it to keep some specific state. It's best to +create an extra subwindow for @@RXVT_NAME@@ and leave it alone. + +The window will not be destroyed when @@RXVT_NAME@@ exits. + +It might be useful to know that @@RXVT_NAME@@ will not close file +descriptors passed to it (except for stdin/out/err, of course), so you +can use file descriptors to communicate with the programs within the +terminal. This works regardless of wether the C<-embed> option was used or +not. + +Here is a short Gtk2-perl snippet that illustrates how this option can be +used (a longer example is in F): + + my $rxvt = new Gtk2::DrawingArea; + $...->add ($rxvt); # important to add it somewhere first + $rxvt->realize; # now it can be realized + my $xid = $rxvt->window->get_xid; + + system "@@RXVT_NAME@@ -embed $xid &"; + +=item B<-pty-fd> I + +Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty +pair but instead use the given filehandle as the tty master. This is +useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator +without having to run a program within it. + +If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp +entries and will not tinker with pty/tty permissions - you have to do that +yourself if you want that. + +Here is a example in perl that illustrates how this option can be used (a +longer example is in F): + + use IO::Pty; + use Fcntl; + + my $pty = new IO::Pty; + fcntl $pty, F_SETFD, 0; # clear close-on-exec + + system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; + + # now communicate with rxvt + my $slave = $pty->slave; + while (<$slave>) { print $slave "got <$_>\n" } =back @@ -694,8 +742,8 @@ =item B I B: scroll with scrollback buffer when tty receives new lines (and -B is False); option B<+sw>. B: do not scroll -with scrollback buffer when tty recieves new lines; option B<-sw>. +B is False); option B<-sw>. B: do not scroll +with scrollback buffer when tty recieves new lines; option B<+sw>. =item B I @@ -1136,8 +1184,8 @@ C to indicate that the default-colour escape sequence is to be used), C is the colour code used as default background colour (or the string C), and C is the string C if @@RXVT_NAME@@ -was compiled with XPM support. Libraries like C can (and do) use -this information to optimize screen output. +was compiled with XPM support. Libraries like C and C can +(and do) use this information to optimize screen output. =item B @@ -1220,9 +1268,9 @@ =item Project Coordinator -@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> +Marc A. Lehmann L<< >> -L<@@RXVT_WEBPAGE@@> +L =back @@ -1257,7 +1305,7 @@ Rewrote screen display and text selection routines. Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) -=item Marc Alexander Lehmann L<< >> +=item Marc Alexander Lehmann L<< >> Forked rxvt-unicode, rewrote most of the display code and internal character handling to store text in unicode, improve xterm